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

filter: Statementstmt 0.0% 0 / 19 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 21 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Transfer::UpdateServer;
3 use Moose;
4 has Certificate => (is => 'ro', isa => 'Str');
5 has EndpointDetails => (is => 'ro', isa => 'Paws::Transfer::EndpointDetails');
6 has EndpointType => (is => 'ro', isa => 'Str');
7 has HostKey => (is => 'ro', isa => 'Str');
8 has IdentityProviderDetails => (is => 'ro', isa => 'Paws::Transfer::IdentityProviderDetails');
9 has LoggingRole => (is => 'ro', isa => 'Str');
10 has ProtocolDetails => (is => 'ro', isa => 'Paws::Transfer::ProtocolDetails');
11 has Protocols => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
12 has SecurityPolicyName => (is => 'ro', isa => 'Str');
13 has ServerId => (is => 'ro', isa => 'Str', required => 1);
14  
15 use MooseX::ClassAttribute;
16  
17 class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateServer');
18 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Transfer::UpdateServerResponse');
19 class_has _result_key => (isa => 'Str', is => 'ro');
20 1;
21  
22 ### main pod documentation begin ###
23  
24 =head1 NAME
25  
26 Paws::Transfer::UpdateServer - Arguments for method UpdateServer on L<Paws::Transfer>
27  
28 =head1 DESCRIPTION
29  
30 This class represents the parameters used for calling the method UpdateServer on the
31 L<AWS Transfer Family|Paws::Transfer> service. Use the attributes of this class
32 as arguments to method UpdateServer.
33  
34 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateServer.
35  
36 =head1 SYNOPSIS
37  
38 my $transfer = Paws->service('Transfer');
39 my $UpdateServerResponse = $transfer->UpdateServer(
40 ServerId => 'MyServerId',
41 Certificate => 'MyCertificate', # OPTIONAL
42 EndpointDetails => {
43 AddressAllocationIds => [ 'MyAddressAllocationId', ... ], # OPTIONAL
44 SecurityGroupIds => [
45 'MySecurityGroupId', ... # min: 11, max: 20
46 ], # OPTIONAL
47 SubnetIds => [ 'MySubnetId', ... ], # OPTIONAL
48 VpcEndpointId => 'MyVpcEndpointId', # min: 22, max: 22; OPTIONAL
49 VpcId => 'MyVpcId', # OPTIONAL
50 }, # OPTIONAL
51 EndpointType => 'PUBLIC', # OPTIONAL
52 HostKey => 'MyHostKey', # OPTIONAL
53 IdentityProviderDetails => {
54 DirectoryId => 'MyDirectoryId', # min: 12, max: 12; OPTIONAL
55 InvocationRole => 'MyRole', # min: 20, max: 2048; OPTIONAL
56 Url => 'MyUrl', # max: 255; OPTIONAL
57 }, # OPTIONAL
58 LoggingRole => 'MyNullableRole', # OPTIONAL
59 ProtocolDetails => {
60 PassiveIp => 'MyPassiveIp', # max: 15; OPTIONAL
61 }, # OPTIONAL
62 Protocols => [
63 'SFTP', ... # values: SFTP, FTP, FTPS
64 ], # OPTIONAL
65 SecurityPolicyName => 'MySecurityPolicyName', # OPTIONAL
66 );
67  
68 # Results:
69 my $ServerId = $UpdateServerResponse->ServerId;
70  
71 # Returns a L<Paws::Transfer::UpdateServerResponse> object.
72  
73 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.
74 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/transfer/UpdateServer>
75  
76 =head1 ATTRIBUTES
77  
78  
79 =head2 Certificate => Str
80  
81 The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate
82 Manager (ACM) certificate. Required when C<Protocols> is set to
83 C<FTPS>.
84  
85 To request a new public certificate, see Request a public certificate
86 (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html)
87 in the I< Amazon Web ServicesCertificate Manager User Guide>.
88  
89 To import an existing certificate into ACM, see Importing certificates
90 into ACM
91 (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html)
92 in the I< Amazon Web ServicesCertificate Manager User Guide>.
93  
94 To request a private certificate to use FTPS through private IP
95 addresses, see Request a private certificate
96 (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html)
97 in the I< Amazon Web ServicesCertificate Manager User Guide>.
98  
99 Certificates with the following cryptographic algorithms and key sizes
100 are supported:
101  
102 =over
103  
104 =item *
105  
106 2048-bit RSA (RSA_2048)
107  
108 =item *
109  
110 4096-bit RSA (RSA_4096)
111  
112 =item *
113  
114 Elliptic Prime Curve 256 bit (EC_prime256v1)
115  
116 =item *
117  
118 Elliptic Prime Curve 384 bit (EC_secp384r1)
119  
120 =item *
121  
122 Elliptic Prime Curve 521 bit (EC_secp521r1)
123  
124 =back
125  
126 The certificate must be a valid SSL/TLS X.509 version 3 certificate
127 with FQDN or IP address specified and information about the issuer.
128  
129  
130  
131 =head2 EndpointDetails => L<Paws::Transfer::EndpointDetails>
132  
133 The virtual private cloud (VPC) endpoint settings that are configured
134 for your server. When you host your endpoint within your VPC, you can
135 make it accessible only to resources within your VPC, or you can attach
136 Elastic IP addresses and make it accessible to clients over the
137 internet. Your VPC's default security groups are automatically assigned
138 to your endpoint.
139  
140  
141  
142 =head2 EndpointType => Str
143  
144 The type of endpoint that you want your server to use. You can choose
145 to make your server's endpoint publicly accessible (PUBLIC) or host it
146 inside your VPC. With an endpoint that is hosted in a VPC, you can
147 restrict access to your server and resources only within your VPC or
148 choose to make it internet facing by attaching Elastic IP addresses
149 directly to it.
150  
151 After May 19, 2021, you won't be able to create a server using
152 C<EndpointType=VPC_ENDPOINT> in your Amazon Web Servicesaccount if your
153 account hasn't already done so before May 19, 2021. If you have already
154 created servers with C<EndpointType=VPC_ENDPOINT> in your Amazon Web
155 Servicesaccount on or before May 19, 2021, you will not be affected.
156 After this date, use C<EndpointType>=C<VPC>.
157  
158 For more information, see
159 https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
160  
161 It is recommended that you use C<VPC> as the C<EndpointType>. With this
162 endpoint type, you have the option to directly associate up to three
163 Elastic IPv4 addresses (BYO IP included) with your server's endpoint
164 and use VPC security groups to restrict traffic by the client's public
165 IP address. This is not possible with C<EndpointType> set to
166 C<VPC_ENDPOINT>.
167  
168 Valid values are: C<"PUBLIC">, C<"VPC">, C<"VPC_ENDPOINT">
169  
170 =head2 HostKey => Str
171  
172 The RSA private key as generated by C<ssh-keygen -N "" -m PEM -f
173 my-new-server-key>.
174  
175 If you aren't planning to migrate existing users from an existing
176 server to a new server, don't update the host key. Accidentally
177 changing a server's host key can be disruptive.
178  
179 For more information, see Change the host key for your SFTP-enabled
180 server
181 (https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key)
182 in the I<Amazon Web ServicesTransfer Family User Guide>.
183  
184  
185  
186 =head2 IdentityProviderDetails => L<Paws::Transfer::IdentityProviderDetails>
187  
188 An array containing all of the information required to call a
189 customer's authentication API method.
190  
191  
192  
193 =head2 LoggingRole => Str
194  
195 Specifies the Amazon Resource Name (ARN) of the Amazon Web Services
196 Identity and Access Management (IAM) role that allows a server to turn
197 on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When
198 set, user activity can be viewed in your CloudWatch logs.
199  
200  
201  
202 =head2 ProtocolDetails => L<Paws::Transfer::ProtocolDetails>
203  
204 The protocol settings that are configured for your server.
205  
206 Use the C<PassiveIp> parameter to indicate passive mode (for FTP and
207 FTPS protocols). Enter a single dotted-quad IPv4 address, such as the
208 external IP address of a firewall, router, or load balancer.
209  
210  
211  
212 =head2 Protocols => ArrayRef[Str|Undef]
213  
214 Specifies the file transfer protocol or protocols over which your file
215 transfer protocol client can connect to your server's endpoint. The
216 available protocols are:
217  
218 =over
219  
220 =item *
221  
222 Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over
223 SSH
224  
225 =item *
226  
227 File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
228  
229 =item *
230  
231 File Transfer Protocol (FTP): Unencrypted file transfer
232  
233 =back
234  
235 If you select C<FTPS>, you must choose a certificate stored in Amazon
236 Web ServicesCertificate Manager (ACM) which will be used to identify
237 your server when clients connect to it over FTPS.
238  
239 If C<Protocol> includes either C<FTP> or C<FTPS>, then the
240 C<EndpointType> must be C<VPC> and the C<IdentityProviderType> must be
241 C<AWS_DIRECTORY_SERVICE> or C<API_GATEWAY>.
242  
243 If C<Protocol> includes C<FTP>, then C<AddressAllocationIds> cannot be
244 associated.
245  
246 If C<Protocol> is set only to C<SFTP>, the C<EndpointType> can be set
247 to C<PUBLIC> and the C<IdentityProviderType> can be set to
248 C<SERVICE_MANAGED>.
249  
250  
251  
252 =head2 SecurityPolicyName => Str
253  
254 Specifies the name of the security policy that is attached to the
255 server.
256  
257  
258  
259 =head2 B<REQUIRED> ServerId => Str
260  
261 A system-assigned unique identifier for a server instance that the user
262 account is assigned to.
263  
264  
265  
266  
267 =head1 SEE ALSO
268  
269 This class forms part of L<Paws>, documenting arguments for method UpdateServer in L<Paws::Transfer>
270  
271 =head1 BUGS and CONTRIBUTIONS
272  
273 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
274  
275 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
276  
277 =cut
278