aws-sdk-transfer 1.27.0 → 1.28.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -48,6 +48,7 @@ module Aws::Transfer
48
48
  # subnet_ids: ["SubnetId"],
49
49
  # vpc_endpoint_id: "VpcEndpointId",
50
50
  # vpc_id: "VpcId",
51
+ # security_group_ids: ["SecurityGroupId"],
51
52
  # },
52
53
  # endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
53
54
  # host_key: "HostKey",
@@ -109,18 +110,18 @@ module Aws::Transfer
109
110
  #
110
111
  # @!attribute [rw] endpoint_details
111
112
  # 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.
113
+ # configured for your server. When you host your endpoint within your
114
+ # VPC, you can make it accessible only to resources within your VPC,
115
+ # or you can attach Elastic IPs and make it accessible to clients over
116
+ # the internet. Your VPC's default security groups are automatically
117
+ # assigned to your endpoint.
117
118
  # @return [Types::EndpointDetails]
118
119
  #
119
120
  # @!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.
121
+ # The type of VPC endpoint that you want your server to connect to.
122
+ # You can choose to connect to the public internet or a VPC endpoint.
123
+ # With a VPC endpoint, you can restrict access to your server and
124
+ # resources only within your VPC.
124
125
  #
125
126
  # <note markdown="1"> It is recommended that you use `VPC` as the `EndpointType`. With
126
127
  # this endpoint type, you have the option to directly associate up to
@@ -157,13 +158,13 @@ module Aws::Transfer
157
158
  # @return [Types::IdentityProviderDetails]
158
159
  #
159
160
  # @!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.
161
+ # Specifies the mode of authentication for a server. The default value
162
+ # is `SERVICE_MANAGED`, which allows you to store and access user
163
+ # credentials within the AWS Transfer Family service. Use the
164
+ # `API_GATEWAY` value to integrate with an identity provider of your
165
+ # choosing. The `API_GATEWAY` setting requires you to provide an API
166
+ # Gateway endpoint URL to call for authentication using the
167
+ # `IdentityProviderDetails` parameter.
167
168
  # @return [String]
168
169
  #
169
170
  # @!attribute [rw] logging_role
@@ -185,9 +186,8 @@ module Aws::Transfer
185
186
  # * `FTP` (File Transfer Protocol): Unencrypted file transfer
186
187
  #
187
188
  # <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.
189
+ # Certificate Manager (ACM) which will be used to identify your server
190
+ # when clients connect to it over FTPS.
191
191
  #
192
192
  # If `Protocol` includes either `FTP` or `FTPS`, then the
193
193
  # `EndpointType` must be `VPC` and the `IdentityProviderType` must be
@@ -209,8 +209,7 @@ module Aws::Transfer
209
209
  # @return [String]
210
210
  #
211
211
  # @!attribute [rw] tags
212
- # Key-value pairs that can be used to group and search for file
213
- # transfer protocol-enabled servers.
212
+ # Key-value pairs that can be used to group and search for servers.
214
213
  # @return [Array<Types::Tag>]
215
214
  #
216
215
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateServerRequest AWS API Documentation
@@ -231,8 +230,7 @@ module Aws::Transfer
231
230
  end
232
231
 
233
232
  # @!attribute [rw] server_id
234
- # The service-assigned ID of the file transfer protocol-enabled server
235
- # that is created.
233
+ # The service-assigned ID of the server that is created.
236
234
  # @return [String]
237
235
  #
238
236
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateServerResponse AWS API Documentation
@@ -270,7 +268,7 @@ module Aws::Transfer
270
268
  #
271
269
  # @!attribute [rw] home_directory
272
270
  # The landing directory (folder) for a user when they log in to the
273
- # file transfer protocol-enabled server using the client.
271
+ # server using the client.
274
272
  #
275
273
  # An example is <i>
276
274
  # <code>your-Amazon-S3-bucket-name&gt;/home/username</code> </i>.
@@ -278,12 +276,11 @@ module Aws::Transfer
278
276
  #
279
277
  # @!attribute [rw] home_directory_type
280
278
  # 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.
279
+ # directory to be when they log into the server. If you set it to
280
+ # `PATH`, the user will see the absolute Amazon S3 bucket paths as is
281
+ # in their file transfer protocol clients. If you set it `LOGICAL`,
282
+ # you will need to provide mappings in the `HomeDirectoryMappings` for
283
+ # how you want to make Amazon S3 paths visible to your users.
287
284
  # @return [String]
288
285
  #
289
286
  # @!attribute [rw] home_directory_mappings
@@ -348,20 +345,18 @@ module Aws::Transfer
348
345
  # bucket. The policies attached to this role will determine the level
349
346
  # of access you want to provide your users when transferring files
350
347
  # 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.
348
+ # should also contain a trust relationship that allows the server to
349
+ # access your resources when servicing your users' transfer requests.
354
350
  # @return [String]
355
351
  #
356
352
  # @!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.
353
+ # A system-assigned unique identifier for a server instance. This is
354
+ # the specific server that you added your user to.
360
355
  # @return [String]
361
356
  #
362
357
  # @!attribute [rw] ssh_public_key_body
363
358
  # The public portion of the Secure Shell (SSH) key used to
364
- # authenticate the user to the file transfer protocol-enabled server.
359
+ # authenticate the user to the server.
365
360
  # @return [String]
366
361
  #
367
362
  # @!attribute [rw] tags
@@ -370,12 +365,12 @@ module Aws::Transfer
370
365
  # @return [Array<Types::Tag>]
371
366
  #
372
367
  # @!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.
368
+ # A unique string that identifies a user and is associated with a as
369
+ # specified by the `ServerId`. This user name must be a minimum of 3
370
+ # and a maximum of 100 characters long. The following are valid
371
+ # characters: a-z, A-Z, 0-9, underscore '\_', hyphen '-', period
372
+ # '.', and at sign '@'. The user name can't start with a hyphen,
373
+ # period, or at sign.
379
374
  # @return [String]
380
375
  #
381
376
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateUserRequest AWS API Documentation
@@ -395,13 +390,12 @@ module Aws::Transfer
395
390
  end
396
391
 
397
392
  # @!attribute [rw] server_id
398
- # The ID of the file transfer protocol-enabled server that the user is
399
- # attached to.
393
+ # The ID of the server that the user is attached to.
400
394
  # @return [String]
401
395
  #
402
396
  # @!attribute [rw] user_name
403
397
  # A unique string that identifies a user account associated with a
404
- # file transfer protocol-enabled server.
398
+ # server.
405
399
  # @return [String]
406
400
  #
407
401
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateUserResponse AWS API Documentation
@@ -421,8 +415,7 @@ module Aws::Transfer
421
415
  # }
422
416
  #
423
417
  # @!attribute [rw] server_id
424
- # A unique system-assigned identifier for a file transfer
425
- # protocol-enabled server instance.
418
+ # A unique system-assigned identifier for a server instance.
426
419
  # @return [String]
427
420
  #
428
421
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteServerRequest AWS API Documentation
@@ -475,13 +468,13 @@ module Aws::Transfer
475
468
  # }
476
469
  #
477
470
  # @!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.
471
+ # A system-assigned unique identifier for a server instance that has
472
+ # the user assigned to it.
480
473
  # @return [String]
481
474
  #
482
475
  # @!attribute [rw] user_name
483
476
  # A unique string that identifies a user that is being deleted from a
484
- # file transfer protocol-enabled server.
477
+ # server.
485
478
  # @return [String]
486
479
  #
487
480
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteUserRequest AWS API Documentation
@@ -533,8 +526,7 @@ module Aws::Transfer
533
526
  # }
534
527
  #
535
528
  # @!attribute [rw] server_id
536
- # A system-assigned unique identifier for a file transfer
537
- # protocol-enabled server.
529
+ # A system-assigned unique identifier for a server.
538
530
  # @return [String]
539
531
  #
540
532
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeServerRequest AWS API Documentation
@@ -546,8 +538,8 @@ module Aws::Transfer
546
538
  end
547
539
 
548
540
  # @!attribute [rw] server
549
- # An array containing the properties of a file transfer
550
- # protocol-enabled server with the `ServerID` you specified.
541
+ # An array containing the properties of a server with the `ServerID`
542
+ # you specified.
551
543
  # @return [Types::DescribedServer]
552
544
  #
553
545
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeServerResponse AWS API Documentation
@@ -567,15 +559,14 @@ module Aws::Transfer
567
559
  # }
568
560
  #
569
561
  # @!attribute [rw] server_id
570
- # A system-assigned unique identifier for a file transfer
571
- # protocol-enabled server that has this user assigned.
562
+ # A system-assigned unique identifier for a server that has this user
563
+ # assigned.
572
564
  # @return [String]
573
565
  #
574
566
  # @!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.
567
+ # The name of the user assigned to one or more servers. User names are
568
+ # part of the sign-in credentials to use the AWS Transfer Family
569
+ # service and perform file transfer tasks.
579
570
  # @return [String]
580
571
  #
581
572
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeUserRequest AWS API Documentation
@@ -588,8 +579,8 @@ module Aws::Transfer
588
579
  end
589
580
 
590
581
  # @!attribute [rw] server_id
591
- # A system-assigned unique identifier for a file transfer
592
- # protocol-enabled server that has this user assigned.
582
+ # A system-assigned unique identifier for a server that has this user
583
+ # assigned.
593
584
  # @return [String]
594
585
  #
595
586
  # @!attribute [rw] user
@@ -663,8 +654,7 @@ module Aws::Transfer
663
654
  # that was specified.
664
655
  #
665
656
  # @!attribute [rw] arn
666
- # Specifies the unique Amazon Resource Name (ARN) of the file transfer
667
- # protocol-enabled server.
657
+ # Specifies the unique Amazon Resource Name (ARN) of the server.
668
658
  # @return [String]
669
659
  #
670
660
  # @!attribute [rw] certificate
@@ -674,14 +664,13 @@ module Aws::Transfer
674
664
  #
675
665
  # @!attribute [rw] endpoint_details
676
666
  # Specifies the virtual private cloud (VPC) endpoint settings that you
677
- # configured for your file transfer protocol-enabled server.
667
+ # configured for your server.
678
668
  # @return [Types::EndpointDetails]
679
669
  #
680
670
  # @!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.
671
+ # Defines the type of endpoint that your server is connected to. If
672
+ # your server is connected to a VPC endpoint, your server isn't
673
+ # accessible over the public internet.
685
674
  # @return [String]
686
675
  #
687
676
  # @!attribute [rw] host_key_fingerprint
@@ -693,23 +682,23 @@ module Aws::Transfer
693
682
  # @!attribute [rw] identity_provider_details
694
683
  # Specifies information to call a customer-supplied authentication
695
684
  # API. This field is not populated when the `IdentityProviderType` of
696
- # a file transfer protocol-enabled server is `SERVICE_MANAGED`.
685
+ # a server is `SERVICE_MANAGED`.
697
686
  # @return [Types::IdentityProviderDetails]
698
687
  #
699
688
  # @!attribute [rw] identity_provider_type
700
689
  # Specifies the mode of authentication method enabled for this
701
690
  # 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.
691
+ # server to store and access user credentials within the service. A
692
+ # value of `API_GATEWAY` indicates that you have integrated an API
693
+ # Gateway endpoint that will be invoked for authenticating your user
694
+ # into the service.
706
695
  # @return [String]
707
696
  #
708
697
  # @!attribute [rw] logging_role
709
698
  # 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.
699
+ # allows a server to turn on Amazon CloudWatch logging for Amazon S3
700
+ # events. When set, user activity can be viewed in your CloudWatch
701
+ # logs.
713
702
  # @return [String]
714
703
  #
715
704
  # @!attribute [rw] protocols
@@ -732,16 +721,15 @@ module Aws::Transfer
732
721
  # @return [String]
733
722
  #
734
723
  # @!attribute [rw] server_id
735
- # Specifies the unique system-assigned identifier for a file transfer
736
- # protocol-enabled server that you instantiate.
724
+ # Specifies the unique system-assigned identifier for a server that
725
+ # you instantiate.
737
726
  # @return [String]
738
727
  #
739
728
  # @!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.
729
+ # Specifies the condition of a server for the server that was
730
+ # described. A value of `ONLINE` indicates that the server can accept
731
+ # jobs and transfer files. A `State` value of `OFFLINE` means that the
732
+ # server cannot perform file transfer operations.
745
733
  #
746
734
  # The states of `STARTING` and `STOPPING` indicate that the server is
747
735
  # in an intermediate state, either not fully able to respond, or not
@@ -751,13 +739,12 @@ module Aws::Transfer
751
739
  #
752
740
  # @!attribute [rw] tags
753
741
  # 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.
742
+ # group servers that were assigned to the server that was described.
756
743
  # @return [Array<Types::Tag>]
757
744
  #
758
745
  # @!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`.
746
+ # Specifies the number of users that are assigned to a server you
747
+ # specified with the `ServerId`.
761
748
  # @return [Integer]
762
749
  #
763
750
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedServer AWS API Documentation
@@ -830,9 +817,8 @@ module Aws::Transfer
830
817
  # Amazon S3 bucket. The policies attached to this role will determine
831
818
  # the level of access you want to provide your users when transferring
832
819
  # 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.
820
+ # should also contain a trust relationship that allows a server to
821
+ # access your resources when servicing your users' transfer requests.
836
822
  # @return [String]
837
823
  #
838
824
  # @!attribute [rw] ssh_public_keys
@@ -848,8 +834,7 @@ module Aws::Transfer
848
834
  # @!attribute [rw] user_name
849
835
  # Specifies the name of the user that was requested to be described.
850
836
  # 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.
837
+ # that will be used by your user when they log in to your server.
853
838
  # @return [String]
854
839
  #
855
840
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedUser AWS API Documentation
@@ -882,23 +867,24 @@ module Aws::Transfer
882
867
  # subnet_ids: ["SubnetId"],
883
868
  # vpc_endpoint_id: "VpcEndpointId",
884
869
  # vpc_id: "VpcId",
870
+ # security_group_ids: ["SecurityGroupId"],
885
871
  # }
886
872
  #
887
873
  # @!attribute [rw] address_allocation_ids
888
874
  # 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.
875
+ # Elastic IP address to your server's endpoint.
891
876
  #
892
- # <note markdown="1"> This property can only be use when `EndpointType` is set to `VPC`.
877
+ # <note markdown="1"> This property can only be set when `EndpointType` is set to `VPC`
878
+ # and it is only valid in the `UpdateServer` API.
893
879
  #
894
880
  # </note>
895
881
  # @return [Array<String>]
896
882
  #
897
883
  # @!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.
884
+ # A list of subnet IDs that are required to host your server endpoint
885
+ # in your VPC.
900
886
  #
901
- # <note markdown="1"> This property can only be used when `EndpointType` is set to `VPC`.
887
+ # <note markdown="1"> This property can only be set when `EndpointType` is set to `VPC`.
902
888
  #
903
889
  # </note>
904
890
  # @return [Array<String>]
@@ -906,28 +892,41 @@ module Aws::Transfer
906
892
  # @!attribute [rw] vpc_endpoint_id
907
893
  # The ID of the VPC endpoint.
908
894
  #
909
- # <note markdown="1"> This property can only be used when `EndpointType` is set to
895
+ # <note markdown="1"> This property can only be set when `EndpointType` is set to
910
896
  # `VPC_ENDPOINT`.
911
897
  #
912
898
  # </note>
913
899
  # @return [String]
914
900
  #
915
901
  # @!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.
902
+ # The VPC ID of the VPC in which a server's endpoint will be hosted.
918
903
  #
919
- # <note markdown="1"> This property can only be used when `EndpointType` is set to `VPC`.
904
+ # <note markdown="1"> This property can only be set when `EndpointType` is set to `VPC`.
920
905
  #
921
906
  # </note>
922
907
  # @return [String]
923
908
  #
909
+ # @!attribute [rw] security_group_ids
910
+ # A list of security groups IDs that are available to attach to your
911
+ # server's endpoint.
912
+ #
913
+ # <note markdown="1"> This property can only be set when `EndpointType` is set to `VPC`.
914
+ #
915
+ # You can only edit the `SecurityGroupIds` property in the
916
+ # `UpdateServer` API and only if you are changing the `EndpointType`
917
+ # from `PUBLIC` or `VPC_ENDPOINT` to `VPC`.
918
+ #
919
+ # </note>
920
+ # @return [Array<String>]
921
+ #
924
922
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/EndpointDetails AWS API Documentation
925
923
  #
926
924
  class EndpointDetails < Struct.new(
927
925
  :address_allocation_ids,
928
926
  :subnet_ids,
929
927
  :vpc_endpoint_id,
930
- :vpc_id)
928
+ :vpc_id,
929
+ :security_group_ids)
931
930
  SENSITIVE = []
932
931
  include Aws::Structure
933
932
  end
@@ -1001,8 +1000,7 @@ module Aws::Transfer
1001
1000
  # }
1002
1001
  #
1003
1002
  # @!attribute [rw] server_id
1004
- # A system-assigned unique identifier for a file transfer
1005
- # protocol-enabled server.
1003
+ # A system-assigned unique identifier for a server.
1006
1004
  # @return [String]
1007
1005
  #
1008
1006
  # @!attribute [rw] ssh_public_key_body
@@ -1010,8 +1008,8 @@ module Aws::Transfer
1010
1008
  # @return [String]
1011
1009
  #
1012
1010
  # @!attribute [rw] user_name
1013
- # The name of the user account that is assigned to one or more file
1014
- # transfer protocol-enabled servers.
1011
+ # The name of the user account that is assigned to one or more
1012
+ # servers.
1015
1013
  # @return [String]
1016
1014
  #
1017
1015
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ImportSshPublicKeyRequest AWS API Documentation
@@ -1024,14 +1022,12 @@ module Aws::Transfer
1024
1022
  include Aws::Structure
1025
1023
  end
1026
1024
 
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.
1025
+ # Identifies the user, the server they belong to, and the identifier of
1026
+ # the SSH public key associated with that user. A user can have more
1027
+ # than one key on each server that they are associated with.
1031
1028
  #
1032
1029
  # @!attribute [rw] server_id
1033
- # A system-assigned unique identifier for a file transfer
1034
- # protocol-enabled server.
1030
+ # A system-assigned unique identifier for a server.
1035
1031
  # @return [String]
1036
1032
  #
1037
1033
  # @!attribute [rw] ssh_public_key_id
@@ -1150,15 +1146,15 @@ module Aws::Transfer
1150
1146
  # }
1151
1147
  #
1152
1148
  # @!attribute [rw] max_results
1153
- # Specifies the number of file transfer protocol-enabled servers to
1154
- # return as a response to the `ListServers` query.
1149
+ # Specifies the number of servers to return as a response to the
1150
+ # `ListServers` query.
1155
1151
  # @return [Integer]
1156
1152
  #
1157
1153
  # @!attribute [rw] next_token
1158
1154
  # When additional results are obtained from the `ListServers` command,
1159
1155
  # a `NextToken` parameter is returned in the output. You can then pass
1160
1156
  # the `NextToken` parameter in a subsequent command to continue
1161
- # listing additional file transfer protocol-enabled servers.
1157
+ # listing additional servers.
1162
1158
  # @return [String]
1163
1159
  #
1164
1160
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListServersRequest AWS API Documentation
@@ -1174,11 +1170,11 @@ module Aws::Transfer
1174
1170
  # When you can get additional results from the `ListServers`
1175
1171
  # operation, a `NextToken` parameter is returned in the output. In a
1176
1172
  # following command, you can pass in the `NextToken` parameter to
1177
- # continue listing additional file transfer protocol-enabled servers.
1173
+ # continue listing additional servers.
1178
1174
  # @return [String]
1179
1175
  #
1180
1176
  # @!attribute [rw] servers
1181
- # An array of file transfer protocol-enabled servers that were listed.
1177
+ # An array of servers that were listed.
1182
1178
  # @return [Array<Types::ListedServer>]
1183
1179
  #
1184
1180
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListServersResponse AWS API Documentation
@@ -1276,8 +1272,8 @@ module Aws::Transfer
1276
1272
  # @return [String]
1277
1273
  #
1278
1274
  # @!attribute [rw] server_id
1279
- # A system-assigned unique identifier for a file transfer
1280
- # protocol-enabled server that has users assigned to it.
1275
+ # A system-assigned unique identifier for a server that has users
1276
+ # assigned to it.
1281
1277
  # @return [String]
1282
1278
  #
1283
1279
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListUsersRequest AWS API Documentation
@@ -1298,8 +1294,8 @@ module Aws::Transfer
1298
1294
  # @return [String]
1299
1295
  #
1300
1296
  # @!attribute [rw] server_id
1301
- # A system-assigned unique identifier for a file transfer
1302
- # protocol-enabled server that the users are assigned to.
1297
+ # A system-assigned unique identifier for a server that the users are
1298
+ # assigned to.
1303
1299
  # @return [String]
1304
1300
  #
1305
1301
  # @!attribute [rw] users
@@ -1321,42 +1317,38 @@ module Aws::Transfer
1321
1317
  # specified.
1322
1318
  #
1323
1319
  # @!attribute [rw] arn
1324
- # Specifies the unique Amazon Resource Name (ARN) for a file transfer
1325
- # protocol-enabled server to be listed.
1320
+ # Specifies the unique Amazon Resource Name (ARN) for a server to be
1321
+ # listed.
1326
1322
  # @return [String]
1327
1323
  #
1328
1324
  # @!attribute [rw] identity_provider_type
1329
1325
  # 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`.
1326
+ # server that was specified. This can include Secure Shell (SSH), user
1327
+ # name and password combinations, or your own custom authentication
1328
+ # method. Valid values include `SERVICE_MANAGED` or `API_GATEWAY`.
1334
1329
  # @return [String]
1335
1330
  #
1336
1331
  # @!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.
1332
+ # Specifies the type of VPC endpoint that your server is connected to.
1333
+ # If your server is connected to a VPC endpoint, your server isn't
1334
+ # accessible over the public internet.
1341
1335
  # @return [String]
1342
1336
  #
1343
1337
  # @!attribute [rw] logging_role
1344
1338
  # 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.
1339
+ # allows a server to turn on Amazon CloudWatch logging.
1347
1340
  # @return [String]
1348
1341
  #
1349
1342
  # @!attribute [rw] server_id
1350
- # Specifies the unique system assigned identifier for a file transfer
1351
- # protocol-enabled servers that were listed.
1343
+ # Specifies the unique system assigned identifier for the servers that
1344
+ # were listed.
1352
1345
  # @return [String]
1353
1346
  #
1354
1347
  # @!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.
1348
+ # Specifies the condition of a server for the server that was
1349
+ # described. A value of `ONLINE` indicates that the server can accept
1350
+ # jobs and transfer files. A `State` value of `OFFLINE` means that the
1351
+ # server cannot perform file transfer operations.
1360
1352
  #
1361
1353
  # The states of `STARTING` and `STOPPING` indicate that the server is
1362
1354
  # in an intermediate state, either not fully able to respond, or not
@@ -1365,8 +1357,8 @@ module Aws::Transfer
1365
1357
  # @return [String]
1366
1358
  #
1367
1359
  # @!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`.
1360
+ # Specifies the number of users that are assigned to a server you
1361
+ # specified with the `ServerId`.
1370
1362
  # @return [Integer]
1371
1363
  #
1372
1364
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListedServer AWS API Documentation
@@ -1533,8 +1525,7 @@ module Aws::Transfer
1533
1525
  # }
1534
1526
  #
1535
1527
  # @!attribute [rw] server_id
1536
- # A system-assigned unique identifier for a file transfer
1537
- # protocol-enabled server that you start.
1528
+ # A system-assigned unique identifier for a server that you start.
1538
1529
  # @return [String]
1539
1530
  #
1540
1531
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StartServerRequest AWS API Documentation
@@ -1553,8 +1544,7 @@ module Aws::Transfer
1553
1544
  # }
1554
1545
  #
1555
1546
  # @!attribute [rw] server_id
1556
- # A system-assigned unique identifier for a file transfer
1557
- # protocol-enabled server that you stopped.
1547
+ # A system-assigned unique identifier for a server that you stopped.
1558
1548
  # @return [String]
1559
1549
  #
1560
1550
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StopServerRequest AWS API Documentation
@@ -1643,9 +1633,8 @@ module Aws::Transfer
1643
1633
  # }
1644
1634
  #
1645
1635
  # @!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.
1636
+ # A system-assigned identifier for a specific server. That server's
1637
+ # user authentication method is tested with a user name and password.
1649
1638
  # @return [String]
1650
1639
  #
1651
1640
  # @!attribute [rw] server_protocol
@@ -1765,6 +1754,7 @@ module Aws::Transfer
1765
1754
  # subnet_ids: ["SubnetId"],
1766
1755
  # vpc_endpoint_id: "VpcEndpointId",
1767
1756
  # vpc_id: "VpcId",
1757
+ # security_group_ids: ["SecurityGroupId"],
1768
1758
  # },
1769
1759
  # endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
1770
1760
  # host_key: "HostKey",
@@ -1820,18 +1810,17 @@ module Aws::Transfer
1820
1810
  #
1821
1811
  # @!attribute [rw] endpoint_details
1822
1812
  # 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.
1813
+ # configured for your server. With a VPC endpoint, you can restrict
1814
+ # access to your server to resources only within your VPC. To control
1815
+ # incoming internet traffic, you will need to associate one or more
1816
+ # Elastic IP addresses with your server's endpoint.
1828
1817
  # @return [Types::EndpointDetails]
1829
1818
  #
1830
1819
  # @!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.
1820
+ # The type of endpoint that you want your server to connect to. You
1821
+ # can choose to connect to the public internet or a VPC endpoint. With
1822
+ # a VPC endpoint, you can restrict access to your server and resources
1823
+ # only within your VPC.
1835
1824
  #
1836
1825
  # <note markdown="1"> It is recommended that you use `VPC` as the `EndpointType`. With
1837
1826
  # this endpoint type, you have the option to directly associate up to
@@ -1848,9 +1837,8 @@ module Aws::Transfer
1848
1837
  # my-new-server-key`.
1849
1838
  #
1850
1839
  # 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.
1840
+ # server to a new server, don't update the host key. Accidentally
1841
+ # changing a server's host key can be disruptive.
1854
1842
  #
1855
1843
  # For more information, see [Change the host key for your SFTP-enabled
1856
1844
  # server][1] in the *AWS Transfer Family User Guide*.
@@ -1908,9 +1896,8 @@ module Aws::Transfer
1908
1896
  # @return [String]
1909
1897
  #
1910
1898
  # @!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.
1899
+ # A system-assigned unique identifier for a server instance that the
1900
+ # user account is assigned to.
1914
1901
  # @return [String]
1915
1902
  #
1916
1903
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateServerRequest AWS API Documentation
@@ -1930,8 +1917,8 @@ module Aws::Transfer
1930
1917
  end
1931
1918
 
1932
1919
  # @!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.
1920
+ # A system-assigned unique identifier for a server that the user
1921
+ # account is assigned to.
1935
1922
  # @return [String]
1936
1923
  #
1937
1924
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateServerResponse AWS API Documentation
@@ -1962,20 +1949,18 @@ module Aws::Transfer
1962
1949
  #
1963
1950
  # @!attribute [rw] home_directory
1964
1951
  # 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.
1952
+ # to the server using their file transfer protocol client.
1967
1953
  #
1968
1954
  # An example is `your-Amazon-S3-bucket-name>/home/username`.
1969
1955
  # @return [String]
1970
1956
  #
1971
1957
  # @!attribute [rw] home_directory_type
1972
1958
  # 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.
1959
+ # directory to be when they log into the server. If you set it to
1960
+ # `PATH`, the user will see the absolute Amazon S3 bucket paths as is
1961
+ # in their file transfer protocol clients. If you set it `LOGICAL`,
1962
+ # you will need to provide mappings in the `HomeDirectoryMappings` for
1963
+ # how you want to make Amazon S3 paths visible to your users.
1979
1964
  # @return [String]
1980
1965
  #
1981
1966
  # @!attribute [rw] home_directory_mappings
@@ -2040,24 +2025,22 @@ module Aws::Transfer
2040
2025
  # bucket. The policies attached to this role will determine the level
2041
2026
  # of access you want to provide your users when transferring files
2042
2027
  # 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.
2028
+ # should also contain a trust relationship that allows the server to
2029
+ # access your resources when servicing your users' transfer requests.
2046
2030
  # @return [String]
2047
2031
  #
2048
2032
  # @!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.
2033
+ # A system-assigned unique identifier for a server instance that the
2034
+ # user account is assigned to.
2052
2035
  # @return [String]
2053
2036
  #
2054
2037
  # @!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.
2038
+ # A unique string that identifies a user and is associated with a
2039
+ # server as specified by the `ServerId`. This user name must be a
2040
+ # minimum of 3 and a maximum of 100 characters long. The following are
2041
+ # valid characters: a-z, A-Z, 0-9, underscore '\_', hyphen '-',
2042
+ # period '.', and at sign '@'. The user name can't start with a
2043
+ # hyphen, period, or at sign.
2061
2044
  # @return [String]
2062
2045
  #
2063
2046
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateUserRequest AWS API Documentation
@@ -2074,19 +2057,17 @@ module Aws::Transfer
2074
2057
  include Aws::Structure
2075
2058
  end
2076
2059
 
2077
- # `UpdateUserResponse` returns the user name and file transfer
2078
- # protocol-enabled server identifier for the request to update a user's
2079
- # properties.
2060
+ # `UpdateUserResponse` returns the user name and identifier for the
2061
+ # request to update a user's properties.
2080
2062
  #
2081
2063
  # @!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.
2064
+ # A system-assigned unique identifier for a server instance that the
2065
+ # user account is assigned to.
2085
2066
  # @return [String]
2086
2067
  #
2087
2068
  # @!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.
2069
+ # The unique identifier for a user that is assigned to a server
2070
+ # instance that was specified in the request.
2090
2071
  # @return [String]
2091
2072
  #
2092
2073
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateUserResponse AWS API Documentation