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

filter: Statementstmt 0.0% 0 / 19 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 20 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::DescribedServer;
3 use Moose;
4 has Arn => (is => 'ro', isa => 'Str', required => 1);
5 has Certificate => (is => 'ro', isa => 'Str');
6 has Domain => (is => 'ro', isa => 'Str');
7 has EndpointDetails => (is => 'ro', isa => 'Paws::Transfer::EndpointDetails');
8 has EndpointType => (is => 'ro', isa => 'Str');
9 has HostKeyFingerprint => (is => 'ro', isa => 'Str');
10 has IdentityProviderDetails => (is => 'ro', isa => 'Paws::Transfer::IdentityProviderDetails');
11 has IdentityProviderType => (is => 'ro', isa => 'Str');
12 has LoggingRole => (is => 'ro', isa => 'Str');
13 has ProtocolDetails => (is => 'ro', isa => 'Paws::Transfer::ProtocolDetails');
14 has Protocols => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
15 has SecurityPolicyName => (is => 'ro', isa => 'Str');
16 has ServerId => (is => 'ro', isa => 'Str');
17 has State => (is => 'ro', isa => 'Str');
18 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Transfer::Tag]');
19 has UserCount => (is => 'ro', isa => 'Int');
20  
21 1;
22  
23 ### main pod documentation begin ###
24  
25 =head1 NAME
26  
27 Paws::Transfer::DescribedServer
28  
29 =head1 USAGE
30  
31 This class represents one of two things:
32  
33 =head3 Arguments in a call to a service
34  
35 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
36 Each attribute should be used as a named argument in the calls that expect this type of object.
37  
38 As an example, if Att1 is expected to be a Paws::Transfer::DescribedServer object:
39  
40 $service_obj->Method(Att1 => { Arn => $value, ..., UserCount => $value });
41  
42 =head3 Results returned from an API call
43  
44 Use accessors for each attribute. If Att1 is expected to be an Paws::Transfer::DescribedServer object:
45  
46 $result = $service_obj->Method(...);
47 $result->Att1->Arn
48  
49 =head1 DESCRIPTION
50  
51 Describes the properties of a file transfer protocol-enabled server
52 that was specified.
53  
54 =head1 ATTRIBUTES
55  
56  
57 =head2 B<REQUIRED> Arn => Str
58  
59 Specifies the unique Amazon Resource Name (ARN) of the server.
60  
61  
62 =head2 Certificate => Str
63  
64 Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM)
65 certificate. Required when C<Protocols> is set to C<FTPS>.
66  
67  
68 =head2 Domain => Str
69  
70 Specifies the domain of the storage system that is used for file
71 transfers.
72  
73  
74 =head2 EndpointDetails => L<Paws::Transfer::EndpointDetails>
75  
76 The virtual private cloud (VPC) endpoint settings that are configured
77 for your server. When you host your endpoint within your VPC, you can
78 make it accessible only to resources within your VPC, or you can attach
79 Elastic IP addresses and make it accessible to clients over the
80 internet. Your VPC's default security groups are automatically assigned
81 to your endpoint.
82  
83  
84 =head2 EndpointType => Str
85  
86 Defines the type of endpoint that your server is connected to. If your
87 server is connected to a VPC endpoint, your server isn't accessible
88 over the public internet.
89  
90  
91 =head2 HostKeyFingerprint => Str
92  
93 Specifies the Base64-encoded SHA256 fingerprint of the server's host
94 key. This value is equivalent to the output of the C<ssh-keygen -l -f
95 my-new-server-key> command.
96  
97  
98 =head2 IdentityProviderDetails => L<Paws::Transfer::IdentityProviderDetails>
99  
100 Specifies information to call a customer-supplied authentication API.
101 This field is not populated when the C<IdentityProviderType> of a
102 server is C<AWS_DIRECTORY_SERVICE> or C<SERVICE_MANAGED>.
103  
104  
105 =head2 IdentityProviderType => Str
106  
107 Specifies the mode of authentication for a server. The default value is
108 C<SERVICE_MANAGED>, which allows you to store and access user
109 credentials within the Amazon Web Services Transfer Family service.
110  
111 Use C<AWS_DIRECTORY_SERVICE> to provide access to Active Directory
112 groups in Amazon Web Services Managed Active Directory or Microsoft
113 Active Directory in your on-premises environment or in Amazon Web
114 Services using AD Connectors. This option also requires you to provide
115 a Directory ID using the C<IdentityProviderDetails> parameter.
116  
117 Use the C<API_GATEWAY> value to integrate with an identity provider of
118 your choosing. The C<API_GATEWAY> setting requires you to provide an
119 API Gateway endpoint URL to call for authentication using the
120 C<IdentityProviderDetails> parameter.
121  
122  
123 =head2 LoggingRole => Str
124  
125 Specifies the Amazon Resource Name (ARN) of the Amazon Web Services
126 Identity and Access Management (IAM) role that allows a server to turn
127 on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When
128 set, user activity can be viewed in your CloudWatch logs.
129  
130  
131 =head2 ProtocolDetails => L<Paws::Transfer::ProtocolDetails>
132  
133 The protocol settings that are configured for your server.
134  
135 Use the C<PassiveIp> parameter to indicate passive mode. Enter a single
136 dotted-quad IPv4 address, such as the external IP address of a
137 firewall, router, or load balancer.
138  
139  
140 =head2 Protocols => ArrayRef[Str|Undef]
141  
142 Specifies the file transfer protocol or protocols over which your file
143 transfer protocol client can connect to your server's endpoint. The
144 available protocols are:
145  
146 =over
147  
148 =item *
149  
150 C<SFTP> (Secure Shell (SSH) File Transfer Protocol): File transfer over
151 SSH
152  
153 =item *
154  
155 C<FTPS> (File Transfer Protocol Secure): File transfer with TLS
156 encryption
157  
158 =item *
159  
160 C<FTP> (File Transfer Protocol): Unencrypted file transfer
161  
162 =back
163  
164  
165  
166 =head2 SecurityPolicyName => Str
167  
168 Specifies the name of the security policy that is attached to the
169 server.
170  
171  
172 =head2 ServerId => Str
173  
174 Specifies the unique system-assigned identifier for a server that you
175 instantiate.
176  
177  
178 =head2 State => Str
179  
180 Specifies the condition of a server for the server that was described.
181 A value of C<ONLINE> indicates that the server can accept jobs and
182 transfer files. A C<State> value of C<OFFLINE> means that the server
183 cannot perform file transfer operations.
184  
185 The states of C<STARTING> and C<STOPPING> indicate that the server is
186 in an intermediate state, either not fully able to respond, or not
187 fully offline. The values of C<START_FAILED> or C<STOP_FAILED> can
188 indicate an error condition.
189  
190  
191 =head2 Tags => ArrayRef[L<Paws::Transfer::Tag>]
192  
193 Specifies the key-value pairs that you can use to search for and group
194 servers that were assigned to the server that was described.
195  
196  
197 =head2 UserCount => Int
198  
199 Specifies the number of users that are assigned to a server you
200 specified with the C<ServerId>.
201  
202  
203  
204 =head1 SEE ALSO
205  
206 This class forms part of L<Paws>, describing an object used in L<Paws::Transfer>
207  
208 =head1 BUGS and CONTRIBUTIONS
209  
210 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
211  
212 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
213  
214 =cut
215