aws-sdk-transfer 1.24.0 → 1.29.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 03e1a4abc91b069cf39b2b826e011e017d6b138598b7031e02378fee7cc69396
4
- data.tar.gz: 93c6c9c172fdfe1f8c6543ed04a0e03d314b60b5a4d3968481ef23125c705160
3
+ metadata.gz: 3c4eb18d9f4d661075e4ac85dd07f8ed54e85bc747c092c28968862fbe3966eb
4
+ data.tar.gz: a26025ad356c8c232c6b5ee1dcd40c68fd91b9d0f7e5080d9aada7c04a57d8ae
5
5
  SHA512:
6
- metadata.gz: 1a342863445121f5dd5093a840db57f70d3bf4f6657bd63898dbb537bc1c4f37523dd90aea1958b2a48b3e635b32e4e86b161206c2a4a38b91bf32a34a778653
7
- data.tar.gz: 663b7d41858f0ec0a5b740e6c2560bb1de2884bf24cade3b647b2964c8b644ffb1f7d9a0c85217077e82f2b87d514880a4e37626c0aba48f92938d18aed0a717
6
+ metadata.gz: 962bcf2e4ba25fbd2831ae425f12347efa2d086fa00874e6882d3e00e9c246e274ec0ffbefe62526e41b4ce7744379307f5d90991db67a9a6a26a64593a01ace
7
+ data.tar.gz: 7a2b5d0706ddb45402fe259f0bd8865f76175a761a207a67daea0ff0bc893c92b079110db0da4aec1bcf170eeaf914bc08542a11c323add406de65323732241c
@@ -7,6 +7,7 @@
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
10
+
10
11
  require 'aws-sdk-core'
11
12
  require 'aws-sigv4'
12
13
 
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-transfer/customizations'
44
45
  #
45
46
  # See {Errors} for more information.
46
47
  #
47
- # @service
48
+ # @!group service
48
49
  module Aws::Transfer
49
50
 
50
- GEM_VERSION = '1.24.0'
51
+ GEM_VERSION = '1.29.0'
51
52
 
52
53
  end
@@ -85,13 +85,28 @@ module Aws::Transfer
85
85
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
86
  # credentials.
87
87
  #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
88
102
  # * `Aws::InstanceProfileCredentials` - Used for loading credentials
89
103
  # from an EC2 IMDS on an EC2 instance.
90
104
  #
91
- # * `Aws::SharedCredentials` - Used for loading credentials from a
92
- # shared file, such as `~/.aws/config`.
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
93
107
  #
94
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
95
110
  #
96
111
  # When `:credentials` are not configured directly, the following
97
112
  # locations will be searched for credentials:
@@ -101,10 +116,10 @@ module Aws::Transfer
101
116
  # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
102
117
  # * `~/.aws/credentials`
103
118
  # * `~/.aws/config`
104
- # * EC2 IMDS instance profile - When used by default, the timeouts are
105
- # very aggressive. Construct and pass an instance of
106
- # `Aws::InstanceProfileCredentails` to enable retries and extended
107
- # timeouts.
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
108
123
  #
109
124
  # @option options [required, String] :region
110
125
  # The AWS region to connect to. The configured `:region` is
@@ -367,19 +382,21 @@ module Aws::Transfer
367
382
  # [2]: https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html
368
383
  # [3]: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html
369
384
  #
385
+ # @option params [String] :domain
386
+ #
370
387
  # @option params [Types::EndpointDetails] :endpoint_details
371
388
  # The virtual private cloud (VPC) endpoint settings that are configured
372
- # for your file transfer protocol-enabled server. When you host your
373
- # endpoint within your VPC, you can make it accessible only to resources
374
- # within your VPC, or you can attach Elastic IPs and make it accessible
375
- # to clients over the internet. Your VPC's default security groups are
376
- # automatically assigned to your endpoint.
389
+ # for your server. When you host your endpoint within your VPC, you can
390
+ # make it accessible only to resources within your VPC, or you can
391
+ # attach Elastic IPs and make it accessible to clients over the
392
+ # internet. Your VPC's default security groups are automatically
393
+ # assigned to your endpoint.
377
394
  #
378
395
  # @option params [String] :endpoint_type
379
- # The type of VPC endpoint that you want your file transfer
380
- # protocol-enabled server to connect to. You can choose to connect to
381
- # the public internet or a VPC endpoint. With a VPC endpoint, you can
382
- # restrict access to your server and resources only within your VPC.
396
+ # The type of VPC endpoint that you want your server to connect to. You
397
+ # can choose to connect to the public internet or a VPC endpoint. With a
398
+ # VPC endpoint, you can restrict access to your server and resources
399
+ # only within your VPC.
383
400
  #
384
401
  # <note markdown="1"> It is recommended that you use `VPC` as the `EndpointType`. With this
385
402
  # endpoint type, you have the option to directly associate up to three
@@ -412,13 +429,13 @@ module Aws::Transfer
412
429
  # Not required when `IdentityProviderType` is set to `SERVICE_MANAGED`.
413
430
  #
414
431
  # @option params [String] :identity_provider_type
415
- # Specifies the mode of authentication for a file transfer
416
- # protocol-enabled server. The default value is `SERVICE_MANAGED`, which
417
- # allows you to store and access user credentials within the AWS
418
- # Transfer Family service. Use the `API_GATEWAY` value to integrate with
419
- # an identity provider of your choosing. The `API_GATEWAY` setting
420
- # requires you to provide an API Gateway endpoint URL to call for
421
- # authentication using the `IdentityProviderDetails` parameter.
432
+ # Specifies the mode of authentication for a server. The default value
433
+ # is `SERVICE_MANAGED`, which allows you to store and access user
434
+ # credentials within the AWS Transfer Family service. Use the
435
+ # `API_GATEWAY` value to integrate with an identity provider of your
436
+ # choosing. The `API_GATEWAY` setting requires you to provide an API
437
+ # Gateway endpoint URL to call for authentication using the
438
+ # `IdentityProviderDetails` parameter.
422
439
  #
423
440
  # @option params [String] :logging_role
424
441
  # Allows the service to write your users' activity to your Amazon
@@ -438,8 +455,8 @@ module Aws::Transfer
438
455
  # * `FTP` (File Transfer Protocol): Unencrypted file transfer
439
456
  #
440
457
  # <note markdown="1"> If you select `FTPS`, you must choose a certificate stored in AWS
441
- # Certificate Manager (ACM) which will be used to identify your file
442
- # transfer protocol-enabled server when clients connect to it over FTPS.
458
+ # Certificate Manager (ACM) which will be used to identify your server
459
+ # when clients connect to it over FTPS.
443
460
  #
444
461
  # If `Protocol` includes either `FTP` or `FTPS`, then the `EndpointType`
445
462
  # must be `VPC` and the `IdentityProviderType` must be `API_GATEWAY`.
@@ -458,8 +475,7 @@ module Aws::Transfer
458
475
  # server.
459
476
  #
460
477
  # @option params [Array<Types::Tag>] :tags
461
- # Key-value pairs that can be used to group and search for file transfer
462
- # protocol-enabled servers.
478
+ # Key-value pairs that can be used to group and search for servers.
463
479
  #
464
480
  # @return [Types::CreateServerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
465
481
  #
@@ -469,11 +485,13 @@ module Aws::Transfer
469
485
  #
470
486
  # resp = client.create_server({
471
487
  # certificate: "Certificate",
488
+ # domain: "S3", # accepts S3, EFS
472
489
  # endpoint_details: {
473
490
  # address_allocation_ids: ["AddressAllocationId"],
474
491
  # subnet_ids: ["SubnetId"],
475
492
  # vpc_endpoint_id: "VpcEndpointId",
476
493
  # vpc_id: "VpcId",
494
+ # security_group_ids: ["SecurityGroupId"],
477
495
  # },
478
496
  # endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
479
497
  # host_key: "HostKey",
@@ -516,20 +534,19 @@ module Aws::Transfer
516
534
  # can be used to group and search for users.
517
535
  #
518
536
  # @option params [String] :home_directory
519
- # The landing directory (folder) for a user when they log in to the file
520
- # transfer protocol-enabled server using the client.
537
+ # The landing directory (folder) for a user when they log in to the
538
+ # server using the client.
521
539
  #
522
540
  # An example is <i>
523
541
  # <code>your-Amazon-S3-bucket-name&gt;/home/username</code> </i>.
524
542
  #
525
543
  # @option params [String] :home_directory_type
526
544
  # The type of landing directory (folder) you want your users' home
527
- # directory to be when they log into the file transfer protocol-enabled
528
- # server. If you set it to `PATH`, the user will see the absolute Amazon
529
- # S3 bucket paths as is in their file transfer protocol clients. If you
530
- # set it `LOGICAL`, you will need to provide mappings in the
531
- # `HomeDirectoryMappings` for how you want to make Amazon S3 paths
532
- # visible to your users.
545
+ # directory to be when they log into the server. If you set it to
546
+ # `PATH`, the user will see the absolute Amazon S3 bucket paths as is in
547
+ # their file transfer protocol clients. If you set it `LOGICAL`, you
548
+ # will need to provide mappings in the `HomeDirectoryMappings` for how
549
+ # you want to make Amazon S3 paths visible to your users.
533
550
  #
534
551
  # @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings
535
552
  # Logical directory mappings that specify what Amazon S3 paths and keys
@@ -585,35 +602,35 @@ module Aws::Transfer
585
602
  # [1]: https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down
586
603
  # [2]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html
587
604
  #
605
+ # @option params [Types::PosixProfile] :posix_profile
606
+ #
588
607
  # @option params [required, String] :role
589
608
  # The IAM role that controls your users' access to your Amazon S3
590
609
  # bucket. The policies attached to this role will determine the level of
591
610
  # access you want to provide your users when transferring files into and
592
611
  # out of your Amazon S3 bucket or buckets. The IAM role should also
593
- # contain a trust relationship that allows the file transfer
594
- # protocol-enabled server to access your resources when servicing your
595
- # users' transfer requests.
612
+ # contain a trust relationship that allows the server to access your
613
+ # resources when servicing your users' transfer requests.
596
614
  #
597
615
  # @option params [required, String] :server_id
598
- # A system-assigned unique identifier for a file transfer
599
- # protocol-enabled server instance. This is the specific server that you
600
- # added your user to.
616
+ # A system-assigned unique identifier for a server instance. This is the
617
+ # specific server that you added your user to.
601
618
  #
602
619
  # @option params [String] :ssh_public_key_body
603
620
  # The public portion of the Secure Shell (SSH) key used to authenticate
604
- # the user to the file transfer protocol-enabled server.
621
+ # the user to the server.
605
622
  #
606
623
  # @option params [Array<Types::Tag>] :tags
607
624
  # Key-value pairs that can be used to group and search for users. Tags
608
625
  # are metadata attached to users for any purpose.
609
626
  #
610
627
  # @option params [required, String] :user_name
611
- # A unique string that identifies a user and is associated with a file
612
- # transfer protocol-enabled server as specified by the `ServerId`. This
613
- # user name must be a minimum of 3 and a maximum of 100 characters long.
614
- # The following are valid characters: a-z, A-Z, 0-9, underscore '\_',
615
- # hyphen '-', period '.', and at sign '@'. The user name can't
616
- # start with a hyphen, period, and at sign.
628
+ # A unique string that identifies a user and is associated with a as
629
+ # specified by the `ServerId`. This user name must be a minimum of 3 and
630
+ # a maximum of 100 characters long. The following are valid characters:
631
+ # a-z, A-Z, 0-9, underscore '\_', hyphen '-', period '.', and at
632
+ # sign '@'. The user name can't start with a hyphen, period, or at
633
+ # sign.
617
634
  #
618
635
  # @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
619
636
  #
@@ -632,6 +649,11 @@ module Aws::Transfer
632
649
  # },
633
650
  # ],
634
651
  # policy: "Policy",
652
+ # posix_profile: {
653
+ # uid: 1, # required
654
+ # gid: 1, # required
655
+ # secondary_gids: [1],
656
+ # },
635
657
  # role: "Role", # required
636
658
  # server_id: "ServerId", # required
637
659
  # ssh_public_key_body: "SshPublicKeyBody",
@@ -663,8 +685,7 @@ module Aws::Transfer
663
685
  # No response returns from this operation.
664
686
  #
665
687
  # @option params [required, String] :server_id
666
- # A unique system-assigned identifier for a file transfer
667
- # protocol-enabled server instance.
688
+ # A unique system-assigned identifier for a server instance.
668
689
  #
669
690
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
670
691
  #
@@ -727,12 +748,12 @@ module Aws::Transfer
727
748
  # </note>
728
749
  #
729
750
  # @option params [required, String] :server_id
730
- # A system-assigned unique identifier for a file transfer
731
- # protocol-enabled server instance that has the user assigned to it.
751
+ # A system-assigned unique identifier for a server instance that has the
752
+ # user assigned to it.
732
753
  #
733
754
  # @option params [required, String] :user_name
734
755
  # A unique string that identifies a user that is being deleted from a
735
- # file transfer protocol-enabled server.
756
+ # server.
736
757
  #
737
758
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
738
759
  #
@@ -805,8 +826,7 @@ module Aws::Transfer
805
826
  # `EndpointDetails`.
806
827
  #
807
828
  # @option params [required, String] :server_id
808
- # A system-assigned unique identifier for a file transfer
809
- # protocol-enabled server.
829
+ # A system-assigned unique identifier for a server.
810
830
  #
811
831
  # @return [Types::DescribeServerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
812
832
  #
@@ -822,12 +842,15 @@ module Aws::Transfer
822
842
  #
823
843
  # resp.server.arn #=> String
824
844
  # resp.server.certificate #=> String
845
+ # resp.server.domain #=> String, one of "S3", "EFS"
825
846
  # resp.server.endpoint_details.address_allocation_ids #=> Array
826
847
  # resp.server.endpoint_details.address_allocation_ids[0] #=> String
827
848
  # resp.server.endpoint_details.subnet_ids #=> Array
828
849
  # resp.server.endpoint_details.subnet_ids[0] #=> String
829
850
  # resp.server.endpoint_details.vpc_endpoint_id #=> String
830
851
  # resp.server.endpoint_details.vpc_id #=> String
852
+ # resp.server.endpoint_details.security_group_ids #=> Array
853
+ # resp.server.endpoint_details.security_group_ids[0] #=> String
831
854
  # resp.server.endpoint_type #=> String, one of "PUBLIC", "VPC", "VPC_ENDPOINT"
832
855
  # resp.server.host_key_fingerprint #=> String
833
856
  # resp.server.identity_provider_details.url #=> String
@@ -860,14 +883,13 @@ module Aws::Transfer
860
883
  # associated with the `ServerId` value that was specified.
861
884
  #
862
885
  # @option params [required, String] :server_id
863
- # A system-assigned unique identifier for a file transfer
864
- # protocol-enabled server that has this user assigned.
886
+ # A system-assigned unique identifier for a server that has this user
887
+ # assigned.
865
888
  #
866
889
  # @option params [required, String] :user_name
867
- # The name of the user assigned to one or more file transfer
868
- # protocol-enabled servers. User names are part of the sign-in
869
- # credentials to use the AWS Transfer Family service and perform file
870
- # transfer tasks.
890
+ # The name of the user assigned to one or more servers. User names are
891
+ # part of the sign-in credentials to use the AWS Transfer Family service
892
+ # and perform file transfer tasks.
871
893
  #
872
894
  # @return [Types::DescribeUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
873
895
  #
@@ -891,6 +913,10 @@ module Aws::Transfer
891
913
  # resp.user.home_directory_mappings[0].target #=> String
892
914
  # resp.user.home_directory_type #=> String, one of "PATH", "LOGICAL"
893
915
  # resp.user.policy #=> String
916
+ # resp.user.posix_profile.uid #=> Integer
917
+ # resp.user.posix_profile.gid #=> Integer
918
+ # resp.user.posix_profile.secondary_gids #=> Array
919
+ # resp.user.posix_profile.secondary_gids[0] #=> Integer
894
920
  # resp.user.role #=> String
895
921
  # resp.user.ssh_public_keys #=> Array
896
922
  # resp.user.ssh_public_keys[0].date_imported #=> Time
@@ -918,15 +944,13 @@ module Aws::Transfer
918
944
  # the name of the `SshPublicKeyId`.
919
945
  #
920
946
  # @option params [required, String] :server_id
921
- # A system-assigned unique identifier for a file transfer
922
- # protocol-enabled server.
947
+ # A system-assigned unique identifier for a server.
923
948
  #
924
949
  # @option params [required, String] :ssh_public_key_body
925
950
  # The public key portion of an SSH key pair.
926
951
  #
927
952
  # @option params [required, String] :user_name
928
- # The name of the user account that is assigned to one or more file
929
- # transfer protocol-enabled servers.
953
+ # The name of the user account that is assigned to one or more servers.
930
954
  #
931
955
  # @return [Types::ImportSshPublicKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
932
956
  #
@@ -1003,14 +1027,14 @@ module Aws::Transfer
1003
1027
  # with your AWS account.
1004
1028
  #
1005
1029
  # @option params [Integer] :max_results
1006
- # Specifies the number of file transfer protocol-enabled servers to
1007
- # return as a response to the `ListServers` query.
1030
+ # Specifies the number of servers to return as a response to the
1031
+ # `ListServers` query.
1008
1032
  #
1009
1033
  # @option params [String] :next_token
1010
1034
  # When additional results are obtained from the `ListServers` command, a
1011
1035
  # `NextToken` parameter is returned in the output. You can then pass the
1012
1036
  # `NextToken` parameter in a subsequent command to continue listing
1013
- # additional file transfer protocol-enabled servers.
1037
+ # additional servers.
1014
1038
  #
1015
1039
  # @return [Types::ListServersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1016
1040
  #
@@ -1031,6 +1055,7 @@ module Aws::Transfer
1031
1055
  # resp.next_token #=> String
1032
1056
  # resp.servers #=> Array
1033
1057
  # resp.servers[0].arn #=> String
1058
+ # resp.servers[0].domain #=> String, one of "S3", "EFS"
1034
1059
  # resp.servers[0].identity_provider_type #=> String, one of "SERVICE_MANAGED", "API_GATEWAY"
1035
1060
  # resp.servers[0].endpoint_type #=> String, one of "PUBLIC", "VPC", "VPC_ENDPOINT"
1036
1061
  # resp.servers[0].logging_role #=> String
@@ -1112,8 +1137,8 @@ module Aws::Transfer
1112
1137
  # additional users.
1113
1138
  #
1114
1139
  # @option params [required, String] :server_id
1115
- # A system-assigned unique identifier for a file transfer
1116
- # protocol-enabled server that has users assigned to it.
1140
+ # A system-assigned unique identifier for a server that has users
1141
+ # assigned to it.
1117
1142
  #
1118
1143
  # @return [Types::ListUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1119
1144
  #
@@ -1164,8 +1189,7 @@ module Aws::Transfer
1164
1189
  # No response is returned from this call.
1165
1190
  #
1166
1191
  # @option params [required, String] :server_id
1167
- # A system-assigned unique identifier for a file transfer
1168
- # protocol-enabled server that you start.
1192
+ # A system-assigned unique identifier for a server that you start.
1169
1193
  #
1170
1194
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1171
1195
  #
@@ -1188,8 +1212,12 @@ module Aws::Transfer
1188
1212
  # `ONLINE` to `OFFLINE`. An `OFFLINE` server cannot accept and process
1189
1213
  # file transfer jobs. Information tied to your server, such as server
1190
1214
  # and user properties, are not affected by stopping your server.
1191
- # Stopping the server will not reduce or impact your file transfer
1192
- # protocol endpoint billing.
1215
+ #
1216
+ # <note markdown="1"> Stopping the server will not reduce or impact your file transfer
1217
+ # protocol endpoint billing; you must delete the server to stop being
1218
+ # billed.
1219
+ #
1220
+ # </note>
1193
1221
  #
1194
1222
  # The state of `STOPPING` indicates that the server is in an
1195
1223
  # intermediate state, either not fully able to respond, or not fully
@@ -1198,8 +1226,7 @@ module Aws::Transfer
1198
1226
  # No response is returned from this call.
1199
1227
  #
1200
1228
  # @option params [required, String] :server_id
1201
- # A system-assigned unique identifier for a file transfer
1202
- # protocol-enabled server that you stopped.
1229
+ # A system-assigned unique identifier for a server that you stopped.
1203
1230
  #
1204
1231
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1205
1232
  #
@@ -1264,9 +1291,8 @@ module Aws::Transfer
1264
1291
  # ensure that your users can successfully use the service.
1265
1292
  #
1266
1293
  # @option params [required, String] :server_id
1267
- # A system-assigned identifier for a specific file transfer
1268
- # protocol-enabled server. That server's user authentication method is
1269
- # tested with a user name and password.
1294
+ # A system-assigned identifier for a specific server. That server's
1295
+ # user authentication method is tested with a user name and password.
1270
1296
  #
1271
1297
  # @option params [String] :server_protocol
1272
1298
  # The type of file transfer protocol to be tested.
@@ -1402,16 +1428,16 @@ module Aws::Transfer
1402
1428
  #
1403
1429
  # @option params [Types::EndpointDetails] :endpoint_details
1404
1430
  # The virtual private cloud (VPC) endpoint settings that are configured
1405
- # for your file transfer protocol-enabled server. With a VPC endpoint,
1406
- # you can restrict access to your server to resources only within your
1407
- # VPC. To control incoming internet traffic, you will need to associate
1408
- # one or more Elastic IP addresses with your server's endpoint.
1431
+ # for your server. With a VPC endpoint, you can restrict access to your
1432
+ # server to resources only within your VPC. To control incoming internet
1433
+ # traffic, you will need to associate one or more Elastic IP addresses
1434
+ # with your server's endpoint.
1409
1435
  #
1410
1436
  # @option params [String] :endpoint_type
1411
- # The type of endpoint that you want your file transfer protocol-enabled
1412
- # server to connect to. You can choose to connect to the public internet
1413
- # or a VPC endpoint. With a VPC endpoint, you can restrict access to
1414
- # your server and resources only within your VPC.
1437
+ # The type of endpoint that you want your server to connect to. You can
1438
+ # choose to connect to the public internet or a VPC endpoint. With a VPC
1439
+ # endpoint, you can restrict access to your server and resources only
1440
+ # within your VPC.
1415
1441
  #
1416
1442
  # <note markdown="1"> It is recommended that you use `VPC` as the `EndpointType`. With this
1417
1443
  # endpoint type, you have the option to directly associate up to three
@@ -1427,9 +1453,8 @@ module Aws::Transfer
1427
1453
  # my-new-server-key`.
1428
1454
  #
1429
1455
  # If you aren't planning to migrate existing users from an existing
1430
- # file transfer protocol-enabled server to a new server, don't update
1431
- # the host key. Accidentally changing a server's host key can be
1432
- # disruptive.
1456
+ # server to a new server, don't update the host key. Accidentally
1457
+ # changing a server's host key can be disruptive.
1433
1458
  #
1434
1459
  # For more information, see [Change the host key for your SFTP-enabled
1435
1460
  # server][1] in the *AWS Transfer Family User Guide*.
@@ -1481,8 +1506,8 @@ module Aws::Transfer
1481
1506
  # server.
1482
1507
  #
1483
1508
  # @option params [required, String] :server_id
1484
- # A system-assigned unique identifier for a file transfer
1485
- # protocol-enabled server instance that the user account is assigned to.
1509
+ # A system-assigned unique identifier for a server instance that the
1510
+ # user account is assigned to.
1486
1511
  #
1487
1512
  # @return [Types::UpdateServerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1488
1513
  #
@@ -1497,6 +1522,7 @@ module Aws::Transfer
1497
1522
  # subnet_ids: ["SubnetId"],
1498
1523
  # vpc_endpoint_id: "VpcEndpointId",
1499
1524
  # vpc_id: "VpcId",
1525
+ # security_group_ids: ["SecurityGroupId"],
1500
1526
  # },
1501
1527
  # endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
1502
1528
  # host_key: "HostKey",
@@ -1532,19 +1558,17 @@ module Aws::Transfer
1532
1558
  #
1533
1559
  # @option params [String] :home_directory
1534
1560
  # Specifies the landing directory (folder) for a user when they log in
1535
- # to the file transfer protocol-enabled server using their file transfer
1536
- # protocol client.
1561
+ # to the server using their file transfer protocol client.
1537
1562
  #
1538
1563
  # An example is `your-Amazon-S3-bucket-name>/home/username`.
1539
1564
  #
1540
1565
  # @option params [String] :home_directory_type
1541
1566
  # The type of landing directory (folder) you want your users' home
1542
- # directory to be when they log into the file transfer protocol-enabled
1543
- # server. If you set it to `PATH`, the user will see the absolute Amazon
1544
- # S3 bucket paths as is in their file transfer protocol clients. If you
1545
- # set it `LOGICAL`, you will need to provide mappings in the
1546
- # `HomeDirectoryMappings` for how you want to make Amazon S3 paths
1547
- # visible to your users.
1567
+ # directory to be when they log into the server. If you set it to
1568
+ # `PATH`, the user will see the absolute Amazon S3 bucket paths as is in
1569
+ # their file transfer protocol clients. If you set it `LOGICAL`, you
1570
+ # will need to provide mappings in the `HomeDirectoryMappings` for how
1571
+ # you want to make Amazon S3 paths visible to your users.
1548
1572
  #
1549
1573
  # @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings
1550
1574
  # Logical directory mappings that specify what Amazon S3 paths and keys
@@ -1600,26 +1624,27 @@ module Aws::Transfer
1600
1624
  # [1]: https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down
1601
1625
  # [2]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html
1602
1626
  #
1627
+ # @option params [Types::PosixProfile] :posix_profile
1628
+ #
1603
1629
  # @option params [String] :role
1604
1630
  # The IAM role that controls your users' access to your Amazon S3
1605
1631
  # bucket. The policies attached to this role will determine the level of
1606
1632
  # access you want to provide your users when transferring files into and
1607
1633
  # out of your Amazon S3 bucket or buckets. The IAM role should also
1608
- # contain a trust relationship that allows the file transfer
1609
- # protocol-enabled server to access your resources when servicing your
1610
- # users' transfer requests.
1634
+ # contain a trust relationship that allows the server to access your
1635
+ # resources when servicing your users' transfer requests.
1611
1636
  #
1612
1637
  # @option params [required, String] :server_id
1613
- # A system-assigned unique identifier for a file transfer
1614
- # protocol-enabled server instance that the user account is assigned to.
1638
+ # A system-assigned unique identifier for a server instance that the
1639
+ # user account is assigned to.
1615
1640
  #
1616
1641
  # @option params [required, String] :user_name
1617
- # A unique string that identifies a user and is associated with a file
1618
- # transfer protocol-enabled server as specified by the `ServerId`. This
1619
- # user name must be a minimum of 3 and a maximum of 100 characters long.
1620
- # The following are valid characters: a-z, A-Z, 0-9, underscore '\_',
1621
- # hyphen '-', period '.', and at sign '@'. The user name can't
1622
- # start with a hyphen, period, and at sign.
1642
+ # A unique string that identifies a user and is associated with a server
1643
+ # as specified by the `ServerId`. This user name must be a minimum of 3
1644
+ # and a maximum of 100 characters long. The following are valid
1645
+ # characters: a-z, A-Z, 0-9, underscore '\_', hyphen '-', period
1646
+ # '.', and at sign '@'. The user name can't start with a hyphen,
1647
+ # period, or at sign.
1623
1648
  #
1624
1649
  # @return [Types::UpdateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1625
1650
  #
@@ -1638,6 +1663,11 @@ module Aws::Transfer
1638
1663
  # },
1639
1664
  # ],
1640
1665
  # policy: "Policy",
1666
+ # posix_profile: {
1667
+ # uid: 1, # required
1668
+ # gid: 1, # required
1669
+ # secondary_gids: [1],
1670
+ # },
1641
1671
  # role: "Role",
1642
1672
  # server_id: "ServerId", # required
1643
1673
  # user_name: "UserName", # required
@@ -1670,7 +1700,7 @@ module Aws::Transfer
1670
1700
  params: params,
1671
1701
  config: config)
1672
1702
  context[:gem_name] = 'aws-sdk-transfer'
1673
- context[:gem_version] = '1.24.0'
1703
+ context[:gem_version] = '1.29.0'
1674
1704
  Seahorse::Client::Request.new(handlers, context)
1675
1705
  end
1676
1706