aws-sdk-transfer 1.26.0 → 1.31.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -36,6 +36,7 @@ module Aws::Transfer
36
36
  DescribedSecurityPolicy = Shapes::StructureShape.new(name: 'DescribedSecurityPolicy')
37
37
  DescribedServer = Shapes::StructureShape.new(name: 'DescribedServer')
38
38
  DescribedUser = Shapes::StructureShape.new(name: 'DescribedUser')
39
+ Domain = Shapes::StringShape.new(name: 'Domain')
39
40
  EndpointDetails = Shapes::StructureShape.new(name: 'EndpointDetails')
40
41
  EndpointType = Shapes::StringShape.new(name: 'EndpointType')
41
42
  Fips = Shapes::BooleanShape.new(name: 'Fips')
@@ -71,6 +72,8 @@ module Aws::Transfer
71
72
  NextToken = Shapes::StringShape.new(name: 'NextToken')
72
73
  NullableRole = Shapes::StringShape.new(name: 'NullableRole')
73
74
  Policy = Shapes::StringShape.new(name: 'Policy')
75
+ PosixId = Shapes::IntegerShape.new(name: 'PosixId')
76
+ PosixProfile = Shapes::StructureShape.new(name: 'PosixProfile')
74
77
  Protocol = Shapes::StringShape.new(name: 'Protocol')
75
78
  Protocols = Shapes::ListShape.new(name: 'Protocols')
76
79
  Resource = Shapes::StringShape.new(name: 'Resource')
@@ -80,6 +83,9 @@ module Aws::Transfer
80
83
  Response = Shapes::StringShape.new(name: 'Response')
81
84
  RetryAfterSeconds = Shapes::StringShape.new(name: 'RetryAfterSeconds')
82
85
  Role = Shapes::StringShape.new(name: 'Role')
86
+ SecondaryGids = Shapes::ListShape.new(name: 'SecondaryGids')
87
+ SecurityGroupId = Shapes::StringShape.new(name: 'SecurityGroupId')
88
+ SecurityGroupIds = Shapes::ListShape.new(name: 'SecurityGroupIds')
83
89
  SecurityPolicyName = Shapes::StringShape.new(name: 'SecurityPolicyName')
84
90
  SecurityPolicyNames = Shapes::ListShape.new(name: 'SecurityPolicyNames')
85
91
  SecurityPolicyOption = Shapes::StringShape.new(name: 'SecurityPolicyOption')
@@ -129,6 +135,7 @@ module Aws::Transfer
129
135
  ConflictException.struct_class = Types::ConflictException
130
136
 
131
137
  CreateServerRequest.add_member(:certificate, Shapes::ShapeRef.new(shape: Certificate, location_name: "Certificate"))
138
+ CreateServerRequest.add_member(:domain, Shapes::ShapeRef.new(shape: Domain, location_name: "Domain"))
132
139
  CreateServerRequest.add_member(:endpoint_details, Shapes::ShapeRef.new(shape: EndpointDetails, location_name: "EndpointDetails"))
133
140
  CreateServerRequest.add_member(:endpoint_type, Shapes::ShapeRef.new(shape: EndpointType, location_name: "EndpointType"))
134
141
  CreateServerRequest.add_member(:host_key, Shapes::ShapeRef.new(shape: HostKey, location_name: "HostKey"))
@@ -147,6 +154,7 @@ module Aws::Transfer
147
154
  CreateUserRequest.add_member(:home_directory_type, Shapes::ShapeRef.new(shape: HomeDirectoryType, location_name: "HomeDirectoryType"))
148
155
  CreateUserRequest.add_member(:home_directory_mappings, Shapes::ShapeRef.new(shape: HomeDirectoryMappings, location_name: "HomeDirectoryMappings"))
149
156
  CreateUserRequest.add_member(:policy, Shapes::ShapeRef.new(shape: Policy, location_name: "Policy"))
157
+ CreateUserRequest.add_member(:posix_profile, Shapes::ShapeRef.new(shape: PosixProfile, location_name: "PosixProfile"))
150
158
  CreateUserRequest.add_member(:role, Shapes::ShapeRef.new(shape: Role, required: true, location_name: "Role"))
151
159
  CreateUserRequest.add_member(:server_id, Shapes::ShapeRef.new(shape: ServerId, required: true, location_name: "ServerId"))
152
160
  CreateUserRequest.add_member(:ssh_public_key_body, Shapes::ShapeRef.new(shape: SshPublicKeyBody, location_name: "SshPublicKeyBody"))
@@ -200,6 +208,7 @@ module Aws::Transfer
200
208
 
201
209
  DescribedServer.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "Arn"))
202
210
  DescribedServer.add_member(:certificate, Shapes::ShapeRef.new(shape: Certificate, location_name: "Certificate"))
211
+ DescribedServer.add_member(:domain, Shapes::ShapeRef.new(shape: Domain, location_name: "Domain"))
203
212
  DescribedServer.add_member(:endpoint_details, Shapes::ShapeRef.new(shape: EndpointDetails, location_name: "EndpointDetails"))
204
213
  DescribedServer.add_member(:endpoint_type, Shapes::ShapeRef.new(shape: EndpointType, location_name: "EndpointType"))
205
214
  DescribedServer.add_member(:host_key_fingerprint, Shapes::ShapeRef.new(shape: HostKeyFingerprint, location_name: "HostKeyFingerprint"))
@@ -219,6 +228,7 @@ module Aws::Transfer
219
228
  DescribedUser.add_member(:home_directory_mappings, Shapes::ShapeRef.new(shape: HomeDirectoryMappings, location_name: "HomeDirectoryMappings"))
220
229
  DescribedUser.add_member(:home_directory_type, Shapes::ShapeRef.new(shape: HomeDirectoryType, location_name: "HomeDirectoryType"))
221
230
  DescribedUser.add_member(:policy, Shapes::ShapeRef.new(shape: Policy, location_name: "Policy"))
231
+ DescribedUser.add_member(:posix_profile, Shapes::ShapeRef.new(shape: PosixProfile, location_name: "PosixProfile"))
222
232
  DescribedUser.add_member(:role, Shapes::ShapeRef.new(shape: Role, location_name: "Role"))
223
233
  DescribedUser.add_member(:ssh_public_keys, Shapes::ShapeRef.new(shape: SshPublicKeys, location_name: "SshPublicKeys"))
224
234
  DescribedUser.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
@@ -229,6 +239,7 @@ module Aws::Transfer
229
239
  EndpointDetails.add_member(:subnet_ids, Shapes::ShapeRef.new(shape: SubnetIds, location_name: "SubnetIds"))
230
240
  EndpointDetails.add_member(:vpc_endpoint_id, Shapes::ShapeRef.new(shape: VpcEndpointId, location_name: "VpcEndpointId"))
231
241
  EndpointDetails.add_member(:vpc_id, Shapes::ShapeRef.new(shape: VpcId, location_name: "VpcId"))
242
+ EndpointDetails.add_member(:security_group_ids, Shapes::ShapeRef.new(shape: SecurityGroupIds, location_name: "SecurityGroupIds"))
232
243
  EndpointDetails.struct_class = Types::EndpointDetails
233
244
 
234
245
  HomeDirectoryMapEntry.add_member(:entry, Shapes::ShapeRef.new(shape: MapEntry, required: true, location_name: "Entry"))
@@ -297,6 +308,7 @@ module Aws::Transfer
297
308
  ListUsersResponse.struct_class = Types::ListUsersResponse
298
309
 
299
310
  ListedServer.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "Arn"))
311
+ ListedServer.add_member(:domain, Shapes::ShapeRef.new(shape: Domain, location_name: "Domain"))
300
312
  ListedServer.add_member(:identity_provider_type, Shapes::ShapeRef.new(shape: IdentityProviderType, location_name: "IdentityProviderType"))
301
313
  ListedServer.add_member(:endpoint_type, Shapes::ShapeRef.new(shape: EndpointType, location_name: "EndpointType"))
302
314
  ListedServer.add_member(:logging_role, Shapes::ShapeRef.new(shape: Role, location_name: "LoggingRole"))
@@ -317,6 +329,11 @@ module Aws::Transfer
317
329
 
318
330
  ListedUsers.member = Shapes::ShapeRef.new(shape: ListedUser)
319
331
 
332
+ PosixProfile.add_member(:uid, Shapes::ShapeRef.new(shape: PosixId, required: true, location_name: "Uid"))
333
+ PosixProfile.add_member(:gid, Shapes::ShapeRef.new(shape: PosixId, required: true, location_name: "Gid"))
334
+ PosixProfile.add_member(:secondary_gids, Shapes::ShapeRef.new(shape: SecondaryGids, location_name: "SecondaryGids"))
335
+ PosixProfile.struct_class = Types::PosixProfile
336
+
320
337
  Protocols.member = Shapes::ShapeRef.new(shape: Protocol)
321
338
 
322
339
  ResourceExistsException.add_member(:message, Shapes::ShapeRef.new(shape: Message, required: true, location_name: "Message"))
@@ -329,6 +346,10 @@ module Aws::Transfer
329
346
  ResourceNotFoundException.add_member(:resource_type, Shapes::ShapeRef.new(shape: ResourceType, required: true, location_name: "ResourceType"))
330
347
  ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
331
348
 
349
+ SecondaryGids.member = Shapes::ShapeRef.new(shape: PosixId)
350
+
351
+ SecurityGroupIds.member = Shapes::ShapeRef.new(shape: SecurityGroupId)
352
+
332
353
  SecurityPolicyNames.member = Shapes::ShapeRef.new(shape: SecurityPolicyName)
333
354
 
334
355
  SecurityPolicyOptions.member = Shapes::ShapeRef.new(shape: SecurityPolicyOption)
@@ -401,6 +422,7 @@ module Aws::Transfer
401
422
  UpdateUserRequest.add_member(:home_directory_type, Shapes::ShapeRef.new(shape: HomeDirectoryType, location_name: "HomeDirectoryType"))
402
423
  UpdateUserRequest.add_member(:home_directory_mappings, Shapes::ShapeRef.new(shape: HomeDirectoryMappings, location_name: "HomeDirectoryMappings"))
403
424
  UpdateUserRequest.add_member(:policy, Shapes::ShapeRef.new(shape: Policy, location_name: "Policy"))
425
+ UpdateUserRequest.add_member(:posix_profile, Shapes::ShapeRef.new(shape: PosixProfile, location_name: "PosixProfile"))
404
426
  UpdateUserRequest.add_member(:role, Shapes::ShapeRef.new(shape: Role, location_name: "Role"))
405
427
  UpdateUserRequest.add_member(:server_id, Shapes::ShapeRef.new(shape: ServerId, required: true, location_name: "ServerId"))
406
428
  UpdateUserRequest.add_member(:user_name, Shapes::ShapeRef.new(shape: UserName, required: true, location_name: "UserName"))
@@ -43,11 +43,13 @@ module Aws::Transfer
43
43
  #
44
44
  # {
45
45
  # certificate: "Certificate",
46
+ # domain: "S3", # accepts S3, EFS
46
47
  # endpoint_details: {
47
48
  # address_allocation_ids: ["AddressAllocationId"],
48
49
  # subnet_ids: ["SubnetId"],
49
50
  # vpc_endpoint_id: "VpcEndpointId",
50
51
  # vpc_id: "VpcId",
52
+ # security_group_ids: ["SecurityGroupId"],
51
53
  # },
52
54
  # endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
53
55
  # host_key: "HostKey",
@@ -107,20 +109,23 @@ module Aws::Transfer
107
109
  # [3]: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html
108
110
  # @return [String]
109
111
  #
112
+ # @!attribute [rw] domain
113
+ # @return [String]
114
+ #
110
115
  # @!attribute [rw] endpoint_details
111
116
  # The virtual private cloud (VPC) endpoint settings that are
112
- # configured for your file transfer protocol-enabled server. When you
113
- # host your endpoint within your VPC, you can make it accessible only
114
- # to resources within your VPC, or you can attach Elastic IPs and make
115
- # it accessible to clients over the internet. Your VPC's default
116
- # security groups are automatically assigned to your endpoint.
117
+ # configured for your server. When you host your endpoint within your
118
+ # VPC, you can make it accessible only to resources within your VPC,
119
+ # or you can attach Elastic IPs and make it accessible to clients over
120
+ # the internet. Your VPC's default security groups are automatically
121
+ # assigned to your endpoint.
117
122
  # @return [Types::EndpointDetails]
118
123
  #
119
124
  # @!attribute [rw] endpoint_type
120
- # The type of VPC endpoint that you want your file transfer
121
- # protocol-enabled server to connect to. You can choose to connect to
122
- # the public internet or a VPC endpoint. With a VPC endpoint, you can
123
- # restrict access to your server and resources only within your VPC.
125
+ # The type of VPC endpoint that you want your server to connect to.
126
+ # You can choose to connect to the public internet or a VPC endpoint.
127
+ # With a VPC endpoint, you can restrict access to your server and
128
+ # resources only within your VPC.
124
129
  #
125
130
  # <note markdown="1"> It is recommended that you use `VPC` as the `EndpointType`. With
126
131
  # this endpoint type, you have the option to directly associate up to
@@ -157,13 +162,13 @@ module Aws::Transfer
157
162
  # @return [Types::IdentityProviderDetails]
158
163
  #
159
164
  # @!attribute [rw] identity_provider_type
160
- # Specifies the mode of authentication for a file transfer
161
- # protocol-enabled server. The default value is `SERVICE_MANAGED`,
162
- # which allows you to store and access user credentials within the AWS
163
- # Transfer Family service. Use the `API_GATEWAY` value to integrate
164
- # with an identity provider of your choosing. The `API_GATEWAY`
165
- # setting requires you to provide an API Gateway endpoint URL to call
166
- # for authentication using the `IdentityProviderDetails` parameter.
165
+ # Specifies the mode of authentication for a server. The default value
166
+ # is `SERVICE_MANAGED`, which allows you to store and access user
167
+ # credentials within the AWS Transfer Family service. Use the
168
+ # `API_GATEWAY` value to integrate with an identity provider of your
169
+ # choosing. The `API_GATEWAY` setting requires you to provide an API
170
+ # Gateway endpoint URL to call for authentication using the
171
+ # `IdentityProviderDetails` parameter.
167
172
  # @return [String]
168
173
  #
169
174
  # @!attribute [rw] logging_role
@@ -185,9 +190,8 @@ module Aws::Transfer
185
190
  # * `FTP` (File Transfer Protocol): Unencrypted file transfer
186
191
  #
187
192
  # <note markdown="1"> If you select `FTPS`, you must choose a certificate stored in AWS
188
- # Certificate Manager (ACM) which will be used to identify your file
189
- # transfer protocol-enabled server when clients connect to it over
190
- # FTPS.
193
+ # Certificate Manager (ACM) which will be used to identify your server
194
+ # when clients connect to it over FTPS.
191
195
  #
192
196
  # If `Protocol` includes either `FTP` or `FTPS`, then the
193
197
  # `EndpointType` must be `VPC` and the `IdentityProviderType` must be
@@ -209,14 +213,14 @@ module Aws::Transfer
209
213
  # @return [String]
210
214
  #
211
215
  # @!attribute [rw] tags
212
- # Key-value pairs that can be used to group and search for file
213
- # transfer protocol-enabled servers.
216
+ # Key-value pairs that can be used to group and search for servers.
214
217
  # @return [Array<Types::Tag>]
215
218
  #
216
219
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateServerRequest AWS API Documentation
217
220
  #
218
221
  class CreateServerRequest < Struct.new(
219
222
  :certificate,
223
+ :domain,
220
224
  :endpoint_details,
221
225
  :endpoint_type,
222
226
  :host_key,
@@ -231,8 +235,7 @@ module Aws::Transfer
231
235
  end
232
236
 
233
237
  # @!attribute [rw] server_id
234
- # The service-assigned ID of the file transfer protocol-enabled server
235
- # that is created.
238
+ # The service-assigned ID of the server that is created.
236
239
  # @return [String]
237
240
  #
238
241
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateServerResponse AWS API Documentation
@@ -256,6 +259,11 @@ module Aws::Transfer
256
259
  # },
257
260
  # ],
258
261
  # policy: "Policy",
262
+ # posix_profile: {
263
+ # uid: 1, # required
264
+ # gid: 1, # required
265
+ # secondary_gids: [1],
266
+ # },
259
267
  # role: "Role", # required
260
268
  # server_id: "ServerId", # required
261
269
  # ssh_public_key_body: "SshPublicKeyBody",
@@ -270,7 +278,7 @@ module Aws::Transfer
270
278
  #
271
279
  # @!attribute [rw] home_directory
272
280
  # The landing directory (folder) for a user when they log in to the
273
- # file transfer protocol-enabled server using the client.
281
+ # server using the client.
274
282
  #
275
283
  # An example is <i>
276
284
  # <code>your-Amazon-S3-bucket-name&gt;/home/username</code> </i>.
@@ -278,12 +286,11 @@ module Aws::Transfer
278
286
  #
279
287
  # @!attribute [rw] home_directory_type
280
288
  # The type of landing directory (folder) you want your users' home
281
- # directory to be when they log into the file transfer
282
- # protocol-enabled server. If you set it to `PATH`, the user will see
283
- # the absolute Amazon S3 bucket paths as is in their file transfer
284
- # protocol clients. If you set it `LOGICAL`, you will need to provide
285
- # mappings in the `HomeDirectoryMappings` for how you want to make
286
- # Amazon S3 paths visible to your users.
289
+ # directory to be when they log into the server. If you set it to
290
+ # `PATH`, the user will see the absolute Amazon S3 bucket paths as is
291
+ # in their file transfer protocol clients. If you set it `LOGICAL`,
292
+ # you will need to provide mappings in the `HomeDirectoryMappings` for
293
+ # how you want to make Amazon S3 paths visible to your users.
287
294
  # @return [String]
288
295
  #
289
296
  # @!attribute [rw] home_directory_mappings
@@ -343,25 +350,26 @@ module Aws::Transfer
343
350
  # [2]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html
344
351
  # @return [String]
345
352
  #
353
+ # @!attribute [rw] posix_profile
354
+ # @return [Types::PosixProfile]
355
+ #
346
356
  # @!attribute [rw] role
347
357
  # The IAM role that controls your users' access to your Amazon S3
348
358
  # bucket. The policies attached to this role will determine the level
349
359
  # of access you want to provide your users when transferring files
350
360
  # into and out of your Amazon S3 bucket or buckets. The IAM role
351
- # should also contain a trust relationship that allows the file
352
- # transfer protocol-enabled server to access your resources when
353
- # servicing your users' transfer requests.
361
+ # should also contain a trust relationship that allows the server to
362
+ # access your resources when servicing your users' transfer requests.
354
363
  # @return [String]
355
364
  #
356
365
  # @!attribute [rw] server_id
357
- # A system-assigned unique identifier for a file transfer
358
- # protocol-enabled server instance. This is the specific server that
359
- # you added your user to.
366
+ # A system-assigned unique identifier for a server instance. This is
367
+ # the specific server that you added your user to.
360
368
  # @return [String]
361
369
  #
362
370
  # @!attribute [rw] ssh_public_key_body
363
371
  # The public portion of the Secure Shell (SSH) key used to
364
- # authenticate the user to the file transfer protocol-enabled server.
372
+ # authenticate the user to the server.
365
373
  # @return [String]
366
374
  #
367
375
  # @!attribute [rw] tags
@@ -370,12 +378,12 @@ module Aws::Transfer
370
378
  # @return [Array<Types::Tag>]
371
379
  #
372
380
  # @!attribute [rw] user_name
373
- # A unique string that identifies a user and is associated with a file
374
- # transfer protocol-enabled server as specified by the `ServerId`.
375
- # This user name must be a minimum of 3 and a maximum of 100
376
- # characters long. The following are valid characters: a-z, A-Z, 0-9,
377
- # underscore '\_', hyphen '-', period '.', and at sign '@'.
378
- # The user name can't start with a hyphen, period, and at sign.
381
+ # A unique string that identifies a user and is associated with a as
382
+ # specified by the `ServerId`. This user name must be a minimum of 3
383
+ # and a maximum of 100 characters long. The following are valid
384
+ # characters: a-z, A-Z, 0-9, underscore '\_', hyphen '-', period
385
+ # '.', and at sign '@'. The user name can't start with a hyphen,
386
+ # period, or at sign.
379
387
  # @return [String]
380
388
  #
381
389
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateUserRequest AWS API Documentation
@@ -385,6 +393,7 @@ module Aws::Transfer
385
393
  :home_directory_type,
386
394
  :home_directory_mappings,
387
395
  :policy,
396
+ :posix_profile,
388
397
  :role,
389
398
  :server_id,
390
399
  :ssh_public_key_body,
@@ -395,13 +404,12 @@ module Aws::Transfer
395
404
  end
396
405
 
397
406
  # @!attribute [rw] server_id
398
- # The ID of the file transfer protocol-enabled server that the user is
399
- # attached to.
407
+ # The ID of the server that the user is attached to.
400
408
  # @return [String]
401
409
  #
402
410
  # @!attribute [rw] user_name
403
411
  # A unique string that identifies a user account associated with a
404
- # file transfer protocol-enabled server.
412
+ # server.
405
413
  # @return [String]
406
414
  #
407
415
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateUserResponse AWS API Documentation
@@ -421,8 +429,7 @@ module Aws::Transfer
421
429
  # }
422
430
  #
423
431
  # @!attribute [rw] server_id
424
- # A unique system-assigned identifier for a file transfer
425
- # protocol-enabled server instance.
432
+ # A unique system-assigned identifier for a server instance.
426
433
  # @return [String]
427
434
  #
428
435
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteServerRequest AWS API Documentation
@@ -475,13 +482,13 @@ module Aws::Transfer
475
482
  # }
476
483
  #
477
484
  # @!attribute [rw] server_id
478
- # A system-assigned unique identifier for a file transfer
479
- # protocol-enabled server instance that has the user assigned to it.
485
+ # A system-assigned unique identifier for a server instance that has
486
+ # the user assigned to it.
480
487
  # @return [String]
481
488
  #
482
489
  # @!attribute [rw] user_name
483
490
  # A unique string that identifies a user that is being deleted from a
484
- # file transfer protocol-enabled server.
491
+ # server.
485
492
  # @return [String]
486
493
  #
487
494
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteUserRequest AWS API Documentation
@@ -533,8 +540,7 @@ module Aws::Transfer
533
540
  # }
534
541
  #
535
542
  # @!attribute [rw] server_id
536
- # A system-assigned unique identifier for a file transfer
537
- # protocol-enabled server.
543
+ # A system-assigned unique identifier for a server.
538
544
  # @return [String]
539
545
  #
540
546
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeServerRequest AWS API Documentation
@@ -546,8 +552,8 @@ module Aws::Transfer
546
552
  end
547
553
 
548
554
  # @!attribute [rw] server
549
- # An array containing the properties of a file transfer
550
- # protocol-enabled server with the `ServerID` you specified.
555
+ # An array containing the properties of a server with the `ServerID`
556
+ # you specified.
551
557
  # @return [Types::DescribedServer]
552
558
  #
553
559
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeServerResponse AWS API Documentation
@@ -567,15 +573,14 @@ module Aws::Transfer
567
573
  # }
568
574
  #
569
575
  # @!attribute [rw] server_id
570
- # A system-assigned unique identifier for a file transfer
571
- # protocol-enabled server that has this user assigned.
576
+ # A system-assigned unique identifier for a server that has this user
577
+ # assigned.
572
578
  # @return [String]
573
579
  #
574
580
  # @!attribute [rw] user_name
575
- # The name of the user assigned to one or more file transfer
576
- # protocol-enabled servers. User names are part of the sign-in
577
- # credentials to use the AWS Transfer Family service and perform file
578
- # transfer tasks.
581
+ # The name of the user assigned to one or more servers. User names are
582
+ # part of the sign-in credentials to use the AWS Transfer Family
583
+ # service and perform file transfer tasks.
579
584
  # @return [String]
580
585
  #
581
586
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeUserRequest AWS API Documentation
@@ -588,8 +593,8 @@ module Aws::Transfer
588
593
  end
589
594
 
590
595
  # @!attribute [rw] server_id
591
- # A system-assigned unique identifier for a file transfer
592
- # protocol-enabled server that has this user assigned.
596
+ # A system-assigned unique identifier for a server that has this user
597
+ # assigned.
593
598
  # @return [String]
594
599
  #
595
600
  # @!attribute [rw] user
@@ -663,8 +668,7 @@ module Aws::Transfer
663
668
  # that was specified.
664
669
  #
665
670
  # @!attribute [rw] arn
666
- # Specifies the unique Amazon Resource Name (ARN) of the file transfer
667
- # protocol-enabled server.
671
+ # Specifies the unique Amazon Resource Name (ARN) of the server.
668
672
  # @return [String]
669
673
  #
670
674
  # @!attribute [rw] certificate
@@ -672,16 +676,18 @@ module Aws::Transfer
672
676
  # Required when `Protocols` is set to `FTPS`.
673
677
  # @return [String]
674
678
  #
679
+ # @!attribute [rw] domain
680
+ # @return [String]
681
+ #
675
682
  # @!attribute [rw] endpoint_details
676
683
  # Specifies the virtual private cloud (VPC) endpoint settings that you
677
- # configured for your file transfer protocol-enabled server.
684
+ # configured for your server.
678
685
  # @return [Types::EndpointDetails]
679
686
  #
680
687
  # @!attribute [rw] endpoint_type
681
- # Defines the type of endpoint that your file transfer
682
- # protocol-enabled server is connected to. If your server is connected
683
- # to a VPC endpoint, your server isn't accessible over the public
684
- # internet.
688
+ # Defines the type of endpoint that your server is connected to. If
689
+ # your server is connected to a VPC endpoint, your server isn't
690
+ # accessible over the public internet.
685
691
  # @return [String]
686
692
  #
687
693
  # @!attribute [rw] host_key_fingerprint
@@ -693,23 +699,23 @@ module Aws::Transfer
693
699
  # @!attribute [rw] identity_provider_details
694
700
  # Specifies information to call a customer-supplied authentication
695
701
  # API. This field is not populated when the `IdentityProviderType` of
696
- # a file transfer protocol-enabled server is `SERVICE_MANAGED`.
702
+ # a server is `SERVICE_MANAGED`.
697
703
  # @return [Types::IdentityProviderDetails]
698
704
  #
699
705
  # @!attribute [rw] identity_provider_type
700
706
  # Specifies the mode of authentication method enabled for this
701
707
  # service. A value of `SERVICE_MANAGED` means that you are using this
702
- # file transfer protocol-enabled server to store and access user
703
- # credentials within the service. A value of `API_GATEWAY` indicates
704
- # that you have integrated an API Gateway endpoint that will be
705
- # invoked for authenticating your user into the service.
708
+ # server to store and access user credentials within the service. A
709
+ # value of `API_GATEWAY` indicates that you have integrated an API
710
+ # Gateway endpoint that will be invoked for authenticating your user
711
+ # into the service.
706
712
  # @return [String]
707
713
  #
708
714
  # @!attribute [rw] logging_role
709
715
  # Specifies the AWS Identity and Access Management (IAM) role that
710
- # allows a file transfer protocol-enabled server to turn on Amazon
711
- # CloudWatch logging for Amazon S3 events. When set, user activity can
712
- # be viewed in your CloudWatch logs.
716
+ # allows a server to turn on Amazon CloudWatch logging for Amazon S3
717
+ # events. When set, user activity can be viewed in your CloudWatch
718
+ # logs.
713
719
  # @return [String]
714
720
  #
715
721
  # @!attribute [rw] protocols
@@ -732,16 +738,15 @@ module Aws::Transfer
732
738
  # @return [String]
733
739
  #
734
740
  # @!attribute [rw] server_id
735
- # Specifies the unique system-assigned identifier for a file transfer
736
- # protocol-enabled server that you instantiate.
741
+ # Specifies the unique system-assigned identifier for a server that
742
+ # you instantiate.
737
743
  # @return [String]
738
744
  #
739
745
  # @!attribute [rw] state
740
- # Specifies the condition of a file transfer protocol-enabled server
741
- # for the server that was described. A value of `ONLINE` indicates
742
- # that the server can accept jobs and transfer files. A `State` value
743
- # of `OFFLINE` means that the server cannot perform file transfer
744
- # operations.
746
+ # Specifies the condition of a server for the server that was
747
+ # described. A value of `ONLINE` indicates that the server can accept
748
+ # jobs and transfer files. A `State` value of `OFFLINE` means that the
749
+ # server cannot perform file transfer operations.
745
750
  #
746
751
  # The states of `STARTING` and `STOPPING` indicate that the server is
747
752
  # in an intermediate state, either not fully able to respond, or not
@@ -751,13 +756,12 @@ module Aws::Transfer
751
756
  #
752
757
  # @!attribute [rw] tags
753
758
  # Specifies the key-value pairs that you can use to search for and
754
- # group file transfer protocol-enabled servers that were assigned to
755
- # the server that was described.
759
+ # group servers that were assigned to the server that was described.
756
760
  # @return [Array<Types::Tag>]
757
761
  #
758
762
  # @!attribute [rw] user_count
759
- # Specifies the number of users that are assigned to a file transfer
760
- # protocol-enabled server you specified with the `ServerId`.
763
+ # Specifies the number of users that are assigned to a server you
764
+ # specified with the `ServerId`.
761
765
  # @return [Integer]
762
766
  #
763
767
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedServer AWS API Documentation
@@ -765,6 +769,7 @@ module Aws::Transfer
765
769
  class DescribedServer < Struct.new(
766
770
  :arn,
767
771
  :certificate,
772
+ :domain,
768
773
  :endpoint_details,
769
774
  :endpoint_type,
770
775
  :host_key_fingerprint,
@@ -825,14 +830,16 @@ module Aws::Transfer
825
830
  # Specifies the name of the policy in use for the described user.
826
831
  # @return [String]
827
832
  #
833
+ # @!attribute [rw] posix_profile
834
+ # @return [Types::PosixProfile]
835
+ #
828
836
  # @!attribute [rw] role
829
837
  # Specifies the IAM role that controls your users' access to your
830
838
  # Amazon S3 bucket. The policies attached to this role will determine
831
839
  # the level of access you want to provide your users when transferring
832
840
  # files into and out of your Amazon S3 bucket or buckets. The IAM role
833
- # should also contain a trust relationship that allows a file transfer
834
- # protocol-enabled server to access your resources when servicing your
835
- # users' transfer requests.
841
+ # should also contain a trust relationship that allows a server to
842
+ # access your resources when servicing your users' transfer requests.
836
843
  # @return [String]
837
844
  #
838
845
  # @!attribute [rw] ssh_public_keys
@@ -848,8 +855,7 @@ module Aws::Transfer
848
855
  # @!attribute [rw] user_name
849
856
  # Specifies the name of the user that was requested to be described.
850
857
  # User names are used for authentication purposes. This is the string
851
- # that will be used by your user when they log in to your file
852
- # transfer protocol-enabled server.
858
+ # that will be used by your user when they log in to your server.
853
859
  # @return [String]
854
860
  #
855
861
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedUser AWS API Documentation
@@ -860,6 +866,7 @@ module Aws::Transfer
860
866
  :home_directory_mappings,
861
867
  :home_directory_type,
862
868
  :policy,
869
+ :posix_profile,
863
870
  :role,
864
871
  :ssh_public_keys,
865
872
  :tags,
@@ -882,23 +889,24 @@ module Aws::Transfer
882
889
  # subnet_ids: ["SubnetId"],
883
890
  # vpc_endpoint_id: "VpcEndpointId",
884
891
  # vpc_id: "VpcId",
892
+ # security_group_ids: ["SecurityGroupId"],
885
893
  # }
886
894
  #
887
895
  # @!attribute [rw] address_allocation_ids
888
896
  # A list of address allocation IDs that are required to attach an
889
- # Elastic IP address to your file transfer protocol-enabled server's
890
- # endpoint. This is only valid in the `UpdateServer` API.
897
+ # Elastic IP address to your server's endpoint.
891
898
  #
892
- # <note markdown="1"> This property can only be use when `EndpointType` is set to `VPC`.
899
+ # <note markdown="1"> This property can only be set when `EndpointType` is set to `VPC`
900
+ # and it is only valid in the `UpdateServer` API.
893
901
  #
894
902
  # </note>
895
903
  # @return [Array<String>]
896
904
  #
897
905
  # @!attribute [rw] subnet_ids
898
- # A list of subnet IDs that are required to host your file transfer
899
- # protocol-enabled server endpoint in your VPC.
906
+ # A list of subnet IDs that are required to host your server endpoint
907
+ # in your VPC.
900
908
  #
901
- # <note markdown="1"> This property can only be used when `EndpointType` is set to `VPC`.
909
+ # <note markdown="1"> This property can only be set when `EndpointType` is set to `VPC`.
902
910
  #
903
911
  # </note>
904
912
  # @return [Array<String>]
@@ -906,28 +914,41 @@ module Aws::Transfer
906
914
  # @!attribute [rw] vpc_endpoint_id
907
915
  # The ID of the VPC endpoint.
908
916
  #
909
- # <note markdown="1"> This property can only be used when `EndpointType` is set to
917
+ # <note markdown="1"> This property can only be set when `EndpointType` is set to
910
918
  # `VPC_ENDPOINT`.
911
919
  #
912
920
  # </note>
913
921
  # @return [String]
914
922
  #
915
923
  # @!attribute [rw] vpc_id
916
- # The VPC ID of the VPC in which a file transfer protocol-enabled
917
- # server's endpoint will be hosted.
924
+ # The VPC ID of the VPC in which a server's endpoint will be hosted.
918
925
  #
919
- # <note markdown="1"> This property can only be used when `EndpointType` is set to `VPC`.
926
+ # <note markdown="1"> This property can only be set when `EndpointType` is set to `VPC`.
920
927
  #
921
928
  # </note>
922
929
  # @return [String]
923
930
  #
931
+ # @!attribute [rw] security_group_ids
932
+ # A list of security groups IDs that are available to attach to your
933
+ # server's endpoint.
934
+ #
935
+ # <note markdown="1"> This property can only be set when `EndpointType` is set to `VPC`.
936
+ #
937
+ # You can only edit the `SecurityGroupIds` property in the
938
+ # `UpdateServer` API and only if you are changing the `EndpointType`
939
+ # from `PUBLIC` or `VPC_ENDPOINT` to `VPC`.
940
+ #
941
+ # </note>
942
+ # @return [Array<String>]
943
+ #
924
944
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/EndpointDetails AWS API Documentation
925
945
  #
926
946
  class EndpointDetails < Struct.new(
927
947
  :address_allocation_ids,
928
948
  :subnet_ids,
929
949
  :vpc_endpoint_id,
930
- :vpc_id)
950
+ :vpc_id,
951
+ :security_group_ids)
931
952
  SENSITIVE = []
932
953
  include Aws::Structure
933
954
  end
@@ -1001,8 +1022,7 @@ module Aws::Transfer
1001
1022
  # }
1002
1023
  #
1003
1024
  # @!attribute [rw] server_id
1004
- # A system-assigned unique identifier for a file transfer
1005
- # protocol-enabled server.
1025
+ # A system-assigned unique identifier for a server.
1006
1026
  # @return [String]
1007
1027
  #
1008
1028
  # @!attribute [rw] ssh_public_key_body
@@ -1010,8 +1030,8 @@ module Aws::Transfer
1010
1030
  # @return [String]
1011
1031
  #
1012
1032
  # @!attribute [rw] user_name
1013
- # The name of the user account that is assigned to one or more file
1014
- # transfer protocol-enabled servers.
1033
+ # The name of the user account that is assigned to one or more
1034
+ # servers.
1015
1035
  # @return [String]
1016
1036
  #
1017
1037
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ImportSshPublicKeyRequest AWS API Documentation
@@ -1024,14 +1044,12 @@ module Aws::Transfer
1024
1044
  include Aws::Structure
1025
1045
  end
1026
1046
 
1027
- # Identifies the user, the file transfer protocol-enabled server they
1028
- # belong to, and the identifier of the SSH public key associated with
1029
- # that user. A user can have more than one key on each server that they
1030
- # are associated with.
1047
+ # Identifies the user, the server they belong to, and the identifier of
1048
+ # the SSH public key associated with that user. A user can have more
1049
+ # than one key on each server that they are associated with.
1031
1050
  #
1032
1051
  # @!attribute [rw] server_id
1033
- # A system-assigned unique identifier for a file transfer
1034
- # protocol-enabled server.
1052
+ # A system-assigned unique identifier for a server.
1035
1053
  # @return [String]
1036
1054
  #
1037
1055
  # @!attribute [rw] ssh_public_key_id
@@ -1150,15 +1168,15 @@ module Aws::Transfer
1150
1168
  # }
1151
1169
  #
1152
1170
  # @!attribute [rw] max_results
1153
- # Specifies the number of file transfer protocol-enabled servers to
1154
- # return as a response to the `ListServers` query.
1171
+ # Specifies the number of servers to return as a response to the
1172
+ # `ListServers` query.
1155
1173
  # @return [Integer]
1156
1174
  #
1157
1175
  # @!attribute [rw] next_token
1158
1176
  # When additional results are obtained from the `ListServers` command,
1159
1177
  # a `NextToken` parameter is returned in the output. You can then pass
1160
1178
  # the `NextToken` parameter in a subsequent command to continue
1161
- # listing additional file transfer protocol-enabled servers.
1179
+ # listing additional servers.
1162
1180
  # @return [String]
1163
1181
  #
1164
1182
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListServersRequest AWS API Documentation
@@ -1174,11 +1192,11 @@ module Aws::Transfer
1174
1192
  # When you can get additional results from the `ListServers`
1175
1193
  # operation, a `NextToken` parameter is returned in the output. In a
1176
1194
  # following command, you can pass in the `NextToken` parameter to
1177
- # continue listing additional file transfer protocol-enabled servers.
1195
+ # continue listing additional servers.
1178
1196
  # @return [String]
1179
1197
  #
1180
1198
  # @!attribute [rw] servers
1181
- # An array of file transfer protocol-enabled servers that were listed.
1199
+ # An array of servers that were listed.
1182
1200
  # @return [Array<Types::ListedServer>]
1183
1201
  #
1184
1202
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListServersResponse AWS API Documentation
@@ -1276,8 +1294,8 @@ module Aws::Transfer
1276
1294
  # @return [String]
1277
1295
  #
1278
1296
  # @!attribute [rw] server_id
1279
- # A system-assigned unique identifier for a file transfer
1280
- # protocol-enabled server that has users assigned to it.
1297
+ # A system-assigned unique identifier for a server that has users
1298
+ # assigned to it.
1281
1299
  # @return [String]
1282
1300
  #
1283
1301
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListUsersRequest AWS API Documentation
@@ -1298,8 +1316,8 @@ module Aws::Transfer
1298
1316
  # @return [String]
1299
1317
  #
1300
1318
  # @!attribute [rw] server_id
1301
- # A system-assigned unique identifier for a file transfer
1302
- # protocol-enabled server that the users are assigned to.
1319
+ # A system-assigned unique identifier for a server that the users are
1320
+ # assigned to.
1303
1321
  # @return [String]
1304
1322
  #
1305
1323
  # @!attribute [rw] users
@@ -1321,42 +1339,41 @@ module Aws::Transfer
1321
1339
  # specified.
1322
1340
  #
1323
1341
  # @!attribute [rw] arn
1324
- # Specifies the unique Amazon Resource Name (ARN) for a file transfer
1325
- # protocol-enabled server to be listed.
1342
+ # Specifies the unique Amazon Resource Name (ARN) for a server to be
1343
+ # listed.
1344
+ # @return [String]
1345
+ #
1346
+ # @!attribute [rw] domain
1326
1347
  # @return [String]
1327
1348
  #
1328
1349
  # @!attribute [rw] identity_provider_type
1329
1350
  # Specifies the authentication method used to validate a user for a
1330
- # file transfer protocol-enabled server that was specified. This can
1331
- # include Secure Shell (SSH), user name and password combinations, or
1332
- # your own custom authentication method. Valid values include
1333
- # `SERVICE_MANAGED` or `API_GATEWAY`.
1351
+ # server that was specified. This can include Secure Shell (SSH), user
1352
+ # name and password combinations, or your own custom authentication
1353
+ # method. Valid values include `SERVICE_MANAGED` or `API_GATEWAY`.
1334
1354
  # @return [String]
1335
1355
  #
1336
1356
  # @!attribute [rw] endpoint_type
1337
- # Specifies the type of VPC endpoint that your file transfer
1338
- # protocol-enabled server is connected to. If your server is connected
1339
- # to a VPC endpoint, your server isn't accessible over the public
1340
- # internet.
1357
+ # Specifies the type of VPC endpoint that your server is connected to.
1358
+ # If your server is connected to a VPC endpoint, your server isn't
1359
+ # accessible over the public internet.
1341
1360
  # @return [String]
1342
1361
  #
1343
1362
  # @!attribute [rw] logging_role
1344
1363
  # Specifies the AWS Identity and Access Management (IAM) role that
1345
- # allows a file transfer protocol-enabled server to turn on Amazon
1346
- # CloudWatch logging.
1364
+ # allows a server to turn on Amazon CloudWatch logging.
1347
1365
  # @return [String]
1348
1366
  #
1349
1367
  # @!attribute [rw] server_id
1350
- # Specifies the unique system assigned identifier for a file transfer
1351
- # protocol-enabled servers that were listed.
1368
+ # Specifies the unique system assigned identifier for the servers that
1369
+ # were listed.
1352
1370
  # @return [String]
1353
1371
  #
1354
1372
  # @!attribute [rw] state
1355
- # Specifies the condition of a file transfer protocol-enabled server
1356
- # for the server that was described. A value of `ONLINE` indicates
1357
- # that the server can accept jobs and transfer files. A `State` value
1358
- # of `OFFLINE` means that the server cannot perform file transfer
1359
- # operations.
1373
+ # Specifies the condition of a server for the server that was
1374
+ # described. A value of `ONLINE` indicates that the server can accept
1375
+ # jobs and transfer files. A `State` value of `OFFLINE` means that the
1376
+ # server cannot perform file transfer operations.
1360
1377
  #
1361
1378
  # The states of `STARTING` and `STOPPING` indicate that the server is
1362
1379
  # in an intermediate state, either not fully able to respond, or not
@@ -1365,14 +1382,15 @@ module Aws::Transfer
1365
1382
  # @return [String]
1366
1383
  #
1367
1384
  # @!attribute [rw] user_count
1368
- # Specifies the number of users that are assigned to a file transfer
1369
- # protocol-enabled server you specified with the `ServerId`.
1385
+ # Specifies the number of users that are assigned to a server you
1386
+ # specified with the `ServerId`.
1370
1387
  # @return [Integer]
1371
1388
  #
1372
1389
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListedServer AWS API Documentation
1373
1390
  #
1374
1391
  class ListedServer < Struct.new(
1375
1392
  :arn,
1393
+ :domain,
1376
1394
  :identity_provider_type,
1377
1395
  :endpoint_type,
1378
1396
  :logging_role,
@@ -1436,6 +1454,34 @@ module Aws::Transfer
1436
1454
  include Aws::Structure
1437
1455
  end
1438
1456
 
1457
+ # @note When making an API call, you may pass PosixProfile
1458
+ # data as a hash:
1459
+ #
1460
+ # {
1461
+ # uid: 1, # required
1462
+ # gid: 1, # required
1463
+ # secondary_gids: [1],
1464
+ # }
1465
+ #
1466
+ # @!attribute [rw] uid
1467
+ # @return [Integer]
1468
+ #
1469
+ # @!attribute [rw] gid
1470
+ # @return [Integer]
1471
+ #
1472
+ # @!attribute [rw] secondary_gids
1473
+ # @return [Array<Integer>]
1474
+ #
1475
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/PosixProfile AWS API Documentation
1476
+ #
1477
+ class PosixProfile < Struct.new(
1478
+ :uid,
1479
+ :gid,
1480
+ :secondary_gids)
1481
+ SENSITIVE = []
1482
+ include Aws::Structure
1483
+ end
1484
+
1439
1485
  # The requested resource does not exist.
1440
1486
  #
1441
1487
  # @!attribute [rw] message
@@ -1533,8 +1579,7 @@ module Aws::Transfer
1533
1579
  # }
1534
1580
  #
1535
1581
  # @!attribute [rw] server_id
1536
- # A system-assigned unique identifier for a file transfer
1537
- # protocol-enabled server that you start.
1582
+ # A system-assigned unique identifier for a server that you start.
1538
1583
  # @return [String]
1539
1584
  #
1540
1585
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StartServerRequest AWS API Documentation
@@ -1553,8 +1598,7 @@ module Aws::Transfer
1553
1598
  # }
1554
1599
  #
1555
1600
  # @!attribute [rw] server_id
1556
- # A system-assigned unique identifier for a file transfer
1557
- # protocol-enabled server that you stopped.
1601
+ # A system-assigned unique identifier for a server that you stopped.
1558
1602
  # @return [String]
1559
1603
  #
1560
1604
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StopServerRequest AWS API Documentation
@@ -1643,9 +1687,8 @@ module Aws::Transfer
1643
1687
  # }
1644
1688
  #
1645
1689
  # @!attribute [rw] server_id
1646
- # A system-assigned identifier for a specific file transfer
1647
- # protocol-enabled server. That server's user authentication method
1648
- # is tested with a user name and password.
1690
+ # A system-assigned identifier for a specific server. That server's
1691
+ # user authentication method is tested with a user name and password.
1649
1692
  # @return [String]
1650
1693
  #
1651
1694
  # @!attribute [rw] server_protocol
@@ -1765,6 +1808,7 @@ module Aws::Transfer
1765
1808
  # subnet_ids: ["SubnetId"],
1766
1809
  # vpc_endpoint_id: "VpcEndpointId",
1767
1810
  # vpc_id: "VpcId",
1811
+ # security_group_ids: ["SecurityGroupId"],
1768
1812
  # },
1769
1813
  # endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
1770
1814
  # host_key: "HostKey",
@@ -1820,18 +1864,17 @@ module Aws::Transfer
1820
1864
  #
1821
1865
  # @!attribute [rw] endpoint_details
1822
1866
  # The virtual private cloud (VPC) endpoint settings that are
1823
- # configured for your file transfer protocol-enabled server. With a
1824
- # VPC endpoint, you can restrict access to your server to resources
1825
- # only within your VPC. To control incoming internet traffic, you will
1826
- # need to associate one or more Elastic IP addresses with your
1827
- # server's endpoint.
1867
+ # configured for your server. With a VPC endpoint, you can restrict
1868
+ # access to your server to resources only within your VPC. To control
1869
+ # incoming internet traffic, you will need to associate one or more
1870
+ # Elastic IP addresses with your server's endpoint.
1828
1871
  # @return [Types::EndpointDetails]
1829
1872
  #
1830
1873
  # @!attribute [rw] endpoint_type
1831
- # The type of endpoint that you want your file transfer
1832
- # protocol-enabled server to connect to. You can choose to connect to
1833
- # the public internet or a VPC endpoint. With a VPC endpoint, you can
1834
- # restrict access to your server and resources only within your VPC.
1874
+ # The type of endpoint that you want your server to connect to. You
1875
+ # can choose to connect to the public internet or a VPC endpoint. With
1876
+ # a VPC endpoint, you can restrict access to your server and resources
1877
+ # only within your VPC.
1835
1878
  #
1836
1879
  # <note markdown="1"> It is recommended that you use `VPC` as the `EndpointType`. With
1837
1880
  # this endpoint type, you have the option to directly associate up to
@@ -1848,9 +1891,8 @@ module Aws::Transfer
1848
1891
  # my-new-server-key`.
1849
1892
  #
1850
1893
  # If you aren't planning to migrate existing users from an existing
1851
- # file transfer protocol-enabled server to a new server, don't update
1852
- # the host key. Accidentally changing a server's host key can be
1853
- # disruptive.
1894
+ # server to a new server, don't update the host key. Accidentally
1895
+ # changing a server's host key can be disruptive.
1854
1896
  #
1855
1897
  # For more information, see [Change the host key for your SFTP-enabled
1856
1898
  # server][1] in the *AWS Transfer Family User Guide*.
@@ -1908,9 +1950,8 @@ module Aws::Transfer
1908
1950
  # @return [String]
1909
1951
  #
1910
1952
  # @!attribute [rw] server_id
1911
- # A system-assigned unique identifier for a file transfer
1912
- # protocol-enabled server instance that the user account is assigned
1913
- # to.
1953
+ # A system-assigned unique identifier for a server instance that the
1954
+ # user account is assigned to.
1914
1955
  # @return [String]
1915
1956
  #
1916
1957
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateServerRequest AWS API Documentation
@@ -1930,8 +1971,8 @@ module Aws::Transfer
1930
1971
  end
1931
1972
 
1932
1973
  # @!attribute [rw] server_id
1933
- # A system-assigned unique identifier for a file transfer
1934
- # protocol-enabled server that the user account is assigned to.
1974
+ # A system-assigned unique identifier for a server that the user
1975
+ # account is assigned to.
1935
1976
  # @return [String]
1936
1977
  #
1937
1978
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateServerResponse AWS API Documentation
@@ -1955,6 +1996,11 @@ module Aws::Transfer
1955
1996
  # },
1956
1997
  # ],
1957
1998
  # policy: "Policy",
1999
+ # posix_profile: {
2000
+ # uid: 1, # required
2001
+ # gid: 1, # required
2002
+ # secondary_gids: [1],
2003
+ # },
1958
2004
  # role: "Role",
1959
2005
  # server_id: "ServerId", # required
1960
2006
  # user_name: "UserName", # required
@@ -1962,20 +2008,18 @@ module Aws::Transfer
1962
2008
  #
1963
2009
  # @!attribute [rw] home_directory
1964
2010
  # Specifies the landing directory (folder) for a user when they log in
1965
- # to the file transfer protocol-enabled server using their file
1966
- # transfer protocol client.
2011
+ # to the server using their file transfer protocol client.
1967
2012
  #
1968
2013
  # An example is `your-Amazon-S3-bucket-name>/home/username`.
1969
2014
  # @return [String]
1970
2015
  #
1971
2016
  # @!attribute [rw] home_directory_type
1972
2017
  # The type of landing directory (folder) you want your users' home
1973
- # directory to be when they log into the file transfer
1974
- # protocol-enabled server. If you set it to `PATH`, the user will see
1975
- # the absolute Amazon S3 bucket paths as is in their file transfer
1976
- # protocol clients. If you set it `LOGICAL`, you will need to provide
1977
- # mappings in the `HomeDirectoryMappings` for how you want to make
1978
- # Amazon S3 paths visible to your users.
2018
+ # directory to be when they log into the server. If you set it to
2019
+ # `PATH`, the user will see the absolute Amazon S3 bucket paths as is
2020
+ # in their file transfer protocol clients. If you set it `LOGICAL`,
2021
+ # you will need to provide mappings in the `HomeDirectoryMappings` for
2022
+ # how you want to make Amazon S3 paths visible to your users.
1979
2023
  # @return [String]
1980
2024
  #
1981
2025
  # @!attribute [rw] home_directory_mappings
@@ -2035,29 +2079,30 @@ module Aws::Transfer
2035
2079
  # [2]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html
2036
2080
  # @return [String]
2037
2081
  #
2082
+ # @!attribute [rw] posix_profile
2083
+ # @return [Types::PosixProfile]
2084
+ #
2038
2085
  # @!attribute [rw] role
2039
2086
  # The IAM role that controls your users' access to your Amazon S3
2040
2087
  # bucket. The policies attached to this role will determine the level
2041
2088
  # of access you want to provide your users when transferring files
2042
2089
  # into and out of your Amazon S3 bucket or buckets. The IAM role
2043
- # should also contain a trust relationship that allows the file
2044
- # transfer protocol-enabled server to access your resources when
2045
- # servicing your users' transfer requests.
2090
+ # should also contain a trust relationship that allows the server to
2091
+ # access your resources when servicing your users' transfer requests.
2046
2092
  # @return [String]
2047
2093
  #
2048
2094
  # @!attribute [rw] server_id
2049
- # A system-assigned unique identifier for a file transfer
2050
- # protocol-enabled server instance that the user account is assigned
2051
- # to.
2095
+ # A system-assigned unique identifier for a server instance that the
2096
+ # user account is assigned to.
2052
2097
  # @return [String]
2053
2098
  #
2054
2099
  # @!attribute [rw] user_name
2055
- # A unique string that identifies a user and is associated with a file
2056
- # transfer protocol-enabled server as specified by the `ServerId`.
2057
- # This user name must be a minimum of 3 and a maximum of 100
2058
- # characters long. The following are valid characters: a-z, A-Z, 0-9,
2059
- # underscore '\_', hyphen '-', period '.', and at sign '@'.
2060
- # The user name can't start with a hyphen, period, and at sign.
2100
+ # A unique string that identifies a user and is associated with a
2101
+ # server as specified by the `ServerId`. This user name must be a
2102
+ # minimum of 3 and a maximum of 100 characters long. The following are
2103
+ # valid characters: a-z, A-Z, 0-9, underscore '\_', hyphen '-',
2104
+ # period '.', and at sign '@'. The user name can't start with a
2105
+ # hyphen, period, or at sign.
2061
2106
  # @return [String]
2062
2107
  #
2063
2108
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateUserRequest AWS API Documentation
@@ -2067,6 +2112,7 @@ module Aws::Transfer
2067
2112
  :home_directory_type,
2068
2113
  :home_directory_mappings,
2069
2114
  :policy,
2115
+ :posix_profile,
2070
2116
  :role,
2071
2117
  :server_id,
2072
2118
  :user_name)
@@ -2074,19 +2120,17 @@ module Aws::Transfer
2074
2120
  include Aws::Structure
2075
2121
  end
2076
2122
 
2077
- # `UpdateUserResponse` returns the user name and file transfer
2078
- # protocol-enabled server identifier for the request to update a user's
2079
- # properties.
2123
+ # `UpdateUserResponse` returns the user name and identifier for the
2124
+ # request to update a user's properties.
2080
2125
  #
2081
2126
  # @!attribute [rw] server_id
2082
- # A system-assigned unique identifier for a file transfer
2083
- # protocol-enabled server instance that the user account is assigned
2084
- # to.
2127
+ # A system-assigned unique identifier for a server instance that the
2128
+ # user account is assigned to.
2085
2129
  # @return [String]
2086
2130
  #
2087
2131
  # @!attribute [rw] user_name
2088
- # The unique identifier for a user that is assigned to a file transfer
2089
- # protocol-enabled server instance that was specified in the request.
2132
+ # The unique identifier for a user that is assigned to a server
2133
+ # instance that was specified in the request.
2090
2134
  # @return [String]
2091
2135
  #
2092
2136
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateUserResponse AWS API Documentation