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

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