aws-sdk-transfer 1.34.0 → 1.35.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: 115a06a68834cb675ee714dfea9ac54b95a43eb7c8c1720986ceda0c14a7fe3f
4
- data.tar.gz: b2bbf016894bc679d1b5b1eb8e473c24e5b016fd88aafe01f69dddea76bfbeab
3
+ metadata.gz: 327c4deee603e20339847e569914d2e06c37fffa2701637750817ba22617e4db
4
+ data.tar.gz: b237e93d727370b0c00b8f9cd13e909b1c8e989df6820bd752698f5e501909b9
5
5
  SHA512:
6
- metadata.gz: 26db8ed0441214e7e29595e746f9d4ca36cfdebeaf0393ae6500b82abd171e0dd7eaed66d6bb5db4c264e381124fce2ffa26e9fc6321676b76c3102c974c2754
7
- data.tar.gz: f558f493d2b8bc8e4deeb0223a0bbeb65c3e1f387bb9526b5de4e1492c1b407db804f83052e77c87c549cbfc0f399997b08e27ee667f7716a4e60abc48ce95dd
6
+ metadata.gz: 6927065160c49fdd282dce11d1e9f81ab2f3f1fae359a37244ae6c188ccf910adc93b02e2085654c9dd128bfeb9fc6cd807207cbfb5dd920002816298cb8fa8d
7
+ data.tar.gz: 0e70a969236064cf90f1e5d6a8d0ac51162f38457db4f47e9733fcecf4c3f42f0e81461be909f36079b27d3ab10a6b2793486331f0aa2c6ed17378004b1923e5
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.35.0 (2021-06-24)
5
+ ------------------
6
+
7
+ * Feature - Customers can successfully use legacy clients with Transfer Family endpoints enabled for FTPS and FTP behind routers, firewalls, and load balancers by providing a Custom IP address used for data channel communication.
8
+
4
9
  1.34.0 (2021-06-09)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.34.0
1
+ 1.35.0
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-transfer/customizations'
48
48
  # @!group service
49
49
  module Aws::Transfer
50
50
 
51
- GEM_VERSION = '1.34.0'
51
+ GEM_VERSION = '1.35.0'
52
52
 
53
53
  end
@@ -339,11 +339,11 @@ module Aws::Transfer
339
339
 
340
340
  # Used by administrators to choose which groups in the directory should
341
341
  # have access to upload and download files over the enabled protocols
342
- # using AWS Transfer Family. For example, a Microsoft Active Directory
343
- # might contain 50,000 users, but only a small fraction might need the
344
- # ability to transfer files to the server. An administrator can use
345
- # `CreateAccess` to limit the access to the correct set of users who
346
- # need this ability.
342
+ # using Amazon Web Services Transfer Family. For example, a Microsoft
343
+ # Active Directory might contain 50,000 users, but only a small fraction
344
+ # might need the ability to transfer files to the server. An
345
+ # administrator can use `CreateAccess` to limit the access to the
346
+ # correct set of users who need this ability.
347
347
  #
348
348
  # @option params [String] :home_directory
349
349
  # The landing directory (folder) for a user when they log in to the
@@ -365,11 +365,11 @@ module Aws::Transfer
365
365
  # paths and keys should be visible to your user and how you want to make
366
366
  # them visible. You must specify the `Entry` and `Target` pair, where
367
367
  # `Entry` shows how the path is made visible and `Target` is the actual
368
- # Amazon S3 or Amazon EFS path. If you only specify a target, it will be
369
- # displayed as is. You also must ensure that your AWS Identity and
370
- # Access Management (IAM) role provides access to paths in `Target`.
371
- # This value can only be set when `HomeDirectoryType` is set to
372
- # *LOGICAL*.
368
+ # Amazon S3 or Amazon EFS path. If you only specify a target, it is
369
+ # displayed as is. You also must ensure that your Amazon Web Services
370
+ # Identity and Access Management (IAM) role provides access to paths in
371
+ # `Target`. This value can only be set when `HomeDirectoryType` is set
372
+ # to *LOGICAL*.
373
373
  #
374
374
  # The following is an `Entry` and `Target` pair example.
375
375
  #
@@ -383,19 +383,16 @@ module Aws::Transfer
383
383
  #
384
384
  # The following is an `Entry` and `Target` pair example for `chroot`.
385
385
  #
386
- # `[ \{ "Entry": "/", "Target": "/bucket_name/home/mydirectory" \} ]`
386
+ # `[ \{ "Entry:": "/", "Target": "/bucket_name/home/mydirectory" \} ]`
387
387
  #
388
388
  # <note markdown="1"> If the target of a logical directory entry does not exist in Amazon S3
389
- # or Amazon EFS, the entry will be ignored. As a workaround, you can use
390
- # the Amazon S3 API or EFS API to create 0-byte objects as place holders
391
- # for your directory. If using the AWS CLI, use the `s3api` or `efsapi`
392
- # call instead of `s3` or `efs` so you can use the `put-object`
393
- # operation. For example, you can use the following.
394
- #
395
- # `aws s3api put-object --bucket bucketname --key path/to/folder/`
396
- #
397
- # The end of the key name must end in a `/` for it to be considered a
398
- # folder.
389
+ # or EFS, the entry is ignored. As a workaround, you can use the Amazon
390
+ # S3 API or EFS API to create 0 byte objects as place holders for your
391
+ # directory. If using the CLI, use the `s3api` or `efsapi` call instead
392
+ # of `s3` or `efs` so you can use the put-object operation. For example,
393
+ # you use the following: `aws s3api put-object --bucket bucketname --key
394
+ # path/to/folder/`. Make sure that the end of the key name ends in a `/`
395
+ # for it to be considered a folder.
399
396
  #
400
397
  # </note>
401
398
  #
@@ -409,16 +406,16 @@ module Aws::Transfer
409
406
  # <note markdown="1"> This only applies when domain of `ServerId` is S3. Amazon EFS does not
410
407
  # use scope-down policies.
411
408
  #
412
- # For scope-down policies, AWS Transfer Family stores the policy as a
413
- # JSON blob, instead of the Amazon Resource Name (ARN) of the policy.
414
- # You save the policy as a JSON blob and pass it in the `Policy`
415
- # argument.
409
+ # For scope-down policies, Amazon Web Services Transfer Family stores
410
+ # the policy as a JSON blob, instead of the Amazon Resource Name (ARN)
411
+ # of the policy. You save the policy as a JSON blob and pass it in the
412
+ # `Policy` argument.
416
413
  #
417
414
  # For an example of a scope-down policy, see [Example scope-down
418
415
  # policy][1].
419
416
  #
420
- # For more information, see [AssumeRole][2] in the *AWS Security Token
421
- # Service API Reference*.
417
+ # For more information, see [AssumeRole][2] in the *Amazon Web Services
418
+ # Security Token Service API Reference*.
422
419
  #
423
420
  # </note>
424
421
  #
@@ -452,9 +449,9 @@ module Aws::Transfer
452
449
  # A unique identifier that is required to identify specific groups
453
450
  # within your directory. The users of the group that you associate have
454
451
  # access to your Amazon S3 or Amazon EFS resources over the enabled
455
- # protocols using AWS Transfer Family. If you know the group name, you
456
- # can view the SID values by running the following command using Windows
457
- # PowerShell.
452
+ # protocols using Amazon Web Services Transfer Family. If you know the
453
+ # group name, you can view the SID values by running the following
454
+ # command using Windows PowerShell.
458
455
  #
459
456
  # `Get-ADGroup -Filter \{samAccountName -like "YourGroupName*"\}
460
457
  # -Properties * | Select SamAccountName,ObjectSid`
@@ -509,25 +506,26 @@ module Aws::Transfer
509
506
  end
510
507
 
511
508
  # Instantiates an auto-scaling virtual server based on the selected file
512
- # transfer protocol in AWS. When you make updates to your file transfer
513
- # protocol-enabled server or when you work with users, use the
514
- # service-generated `ServerId` property that is assigned to the newly
515
- # created server.
509
+ # transfer protocol in Amazon Web Services. When you make updates to
510
+ # your file transfer protocol-enabled server or when you work with
511
+ # users, use the service-generated `ServerId` property that is assigned
512
+ # to the newly created server.
516
513
  #
517
514
  # @option params [String] :certificate
518
- # The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM)
519
- # certificate. Required when `Protocols` is set to `FTPS`.
515
+ # The Amazon Resource Name (ARN) of the Amazon Web Services Certificate
516
+ # Manager (ACM) certificate. Required when `Protocols` is set to `FTPS`.
520
517
  #
521
518
  # To request a new public certificate, see [Request a public
522
- # certificate][1] in the <i> AWS Certificate Manager User Guide</i>.
519
+ # certificate][1] in the <i> Amazon Web Services Certificate Manager
520
+ # User Guide</i>.
523
521
  #
524
522
  # To import an existing certificate into ACM, see [Importing
525
- # certificates into ACM][2] in the <i> AWS Certificate Manager User
526
- # Guide</i>.
523
+ # certificates into ACM][2] in the <i> Amazon Web Services Certificate
524
+ # Manager User Guide</i>.
527
525
  #
528
526
  # To request a private certificate to use FTPS through private IP
529
- # addresses, see [Request a private certificate][3] in the <i> AWS
530
- # Certificate Manager User Guide</i>.
527
+ # addresses, see [Request a private certificate][3] in the <i> Amazon
528
+ # Web Services Certificate Manager User Guide</i>.
531
529
  #
532
530
  # Certificates with the following cryptographic algorithms and key sizes
533
531
  # are supported:
@@ -580,11 +578,11 @@ module Aws::Transfer
580
578
  # directly to it.
581
579
  #
582
580
  # <note markdown="1"> After May 19, 2021, you won't be able to create a server using
583
- # `EndpointType=VPC_ENDPOINT` in your AWS account if your account
584
- # hasn't already done so before May 19, 2021. If you have already
585
- # created servers with `EndpointType=VPC_ENDPOINT` in your AWS account
586
- # on or before May 19, 2021, you will not be affected. After this date,
587
- # use `EndpointType`=`VPC`.
581
+ # `EndpointType=VPC_ENDPOINT` in your Amazon Web Services account if
582
+ # your account hasn't already done so before May 19, 2021. If you have
583
+ # already created servers with `EndpointType=VPC_ENDPOINT` in your
584
+ # Amazon Web Services account on or before May 19, 2021, you will not be
585
+ # affected. After this date, use `EndpointType`=`VPC`.
588
586
  #
589
587
  # For more information, see
590
588
  # https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
@@ -607,7 +605,7 @@ module Aws::Transfer
607
605
  # Accidentally changing a server's host key can be disruptive.
608
606
  #
609
607
  # For more information, see [Change the host key for your SFTP-enabled
610
- # server][1] in the *AWS Transfer Family User Guide*.
608
+ # server][1] in the *Amazon Web Services Transfer Family User Guide*.
611
609
  #
612
610
  #
613
611
  #
@@ -623,20 +621,24 @@ module Aws::Transfer
623
621
  # @option params [String] :identity_provider_type
624
622
  # Specifies the mode of authentication for a server. The default value
625
623
  # is `SERVICE_MANAGED`, which allows you to store and access user
626
- # credentials within the AWS Transfer Family service. Use
627
- # `AWS_DIRECTORY_SERVICE` to provide access to Active Directory groups
628
- # in AWS Managed Active Directory or Microsoft Active Directory in your
629
- # on-premises environment or in AWS using AD Connectors. This option
630
- # also requires you to provide a Directory ID using the
631
- # `IdentityProviderDetails` parameter. Use the `API_GATEWAY` value to
632
- # integrate with an identity provider of your choosing. The
633
- # `API_GATEWAY` setting requires you to provide an API Gateway endpoint
634
- # URL to call for authentication using the `IdentityProviderDetails`
635
- # parameter.
624
+ # credentials within the Amazon Web Services Transfer Family service.
625
+ #
626
+ # Use `AWS_DIRECTORY_SERVICE` to provide access to Active Directory
627
+ # groups in Amazon Web Services Managed Active Directory or Microsoft
628
+ # Active Directory in your on-premises environment or in Amazon Web
629
+ # Services using AD Connectors. This option also requires you to provide
630
+ # a Directory ID using the `IdentityProviderDetails` parameter.
631
+ #
632
+ # Use the `API_GATEWAY` value to integrate with an identity provider of
633
+ # your choosing. The `API_GATEWAY` setting requires you to provide an
634
+ # API Gateway endpoint URL to call for authentication using the
635
+ # `IdentityProviderDetails` parameter.
636
636
  #
637
637
  # @option params [String] :logging_role
638
- # Allows the service to write your users' activity to your Amazon
639
- # CloudWatch logs for monitoring and auditing purposes.
638
+ # Specifies the Amazon Resource Name (ARN) of the Amazon Web Services
639
+ # Identity and Access Management (IAM) role that allows a server to turn
640
+ # on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When
641
+ # set, user activity can be viewed in your CloudWatch logs.
640
642
  #
641
643
  # @option params [Array<String>] :protocols
642
644
  # Specifies the file transfer protocol or protocols over which your file
@@ -651,9 +653,9 @@ module Aws::Transfer
651
653
  #
652
654
  # * `FTP` (File Transfer Protocol): Unencrypted file transfer
653
655
  #
654
- # <note markdown="1"> If you select `FTPS`, you must choose a certificate stored in AWS
655
- # Certificate Manager (ACM) which will be used to identify your server
656
- # when clients connect to it over FTPS.
656
+ # <note markdown="1"> If you select `FTPS`, you must choose a certificate stored in Amazon
657
+ # Web Services Certificate Manager (ACM) which is used to identify your
658
+ # server when clients connect to it over FTPS.
657
659
  #
658
660
  # If `Protocol` includes either `FTP` or `FTPS`, then the `EndpointType`
659
661
  # must be `VPC` and the `IdentityProviderType` must be
@@ -728,9 +730,9 @@ module Aws::Transfer
728
730
  # servers that have the `IdentityProviderType` set to `SERVICE_MANAGED`.
729
731
  # Using parameters for `CreateUser`, you can specify the user name, set
730
732
  # the home directory, store the user's public key, and assign the
731
- # user's AWS Identity and Access Management (IAM) role. You can also
732
- # optionally add a scope-down policy, and assign metadata with tags that
733
- # can be used to group and search for users.
733
+ # user's Amazon Web Services Identity and Access Management (IAM) role.
734
+ # You can also optionally add a scope-down policy, and assign metadata
735
+ # with tags that can be used to group and search for users.
734
736
  #
735
737
  # @option params [String] :home_directory
736
738
  # The landing directory (folder) for a user when they log in to the
@@ -748,14 +750,15 @@ module Aws::Transfer
748
750
  # paths visible to your users.
749
751
  #
750
752
  # @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings
751
- # Logical directory mappings that specify what Amazon S3 or EFS paths
752
- # and keys should be visible to your user and how you want to make them
753
- # visible. You will need to specify the `Entry` and `Target` pair, where
753
+ # Logical directory mappings that specify what Amazon S3 or Amazon EFS
754
+ # paths and keys should be visible to your user and how you want to make
755
+ # them visible. You must specify the `Entry` and `Target` pair, where
754
756
  # `Entry` shows how the path is made visible and `Target` is the actual
755
- # Amazon S3 or EFS path. If you only specify a target, it will be
756
- # displayed as is. You will need to also make sure that your IAM role
757
- # provides access to paths in `Target`. This value can only be set when
758
- # `HomeDirectoryType` is set to `LOGICAL`.
757
+ # Amazon S3 or Amazon EFS path. If you only specify a target, it is
758
+ # displayed as is. You also must ensure that your Amazon Web Services
759
+ # Identity and Access Management (IAM) role provides access to paths in
760
+ # `Target`. This value can only be set when `HomeDirectoryType` is set
761
+ # to *LOGICAL*.
759
762
  #
760
763
  # The following is an `Entry` and `Target` pair example.
761
764
  #
@@ -769,16 +772,16 @@ module Aws::Transfer
769
772
  #
770
773
  # The following is an `Entry` and `Target` pair example for `chroot`.
771
774
  #
772
- # `[ \{ "Entry": "/", "Target": "/bucket_name/home/mydirectory" \} ]`
775
+ # `[ \{ "Entry:": "/", "Target": "/bucket_name/home/mydirectory" \} ]`
773
776
  #
774
777
  # <note markdown="1"> If the target of a logical directory entry does not exist in Amazon S3
775
- # or EFS, the entry will be ignored. As a workaround, you can use the
776
- # Amazon S3 API or EFS API to create 0 byte objects as place holders for
777
- # your directory. If using the CLI, use the `s3api` or `efsapi` call
778
- # instead of `s3` or `efs` so you can use the put-object operation. For
779
- # example, you use the following: `aws s3api put-object --bucket
780
- # bucketname --key path/to/folder/`. Make sure that the end of the key
781
- # name ends in a `/` for it to be considered a folder.
778
+ # or EFS, the entry is ignored. As a workaround, you can use the Amazon
779
+ # S3 API or EFS API to create 0 byte objects as place holders for your
780
+ # directory. If using the CLI, use the `s3api` or `efsapi` call instead
781
+ # of `s3` or `efs` so you can use the put-object operation. For example,
782
+ # you use the following: `aws s3api put-object --bucket bucketname --key
783
+ # path/to/folder/`. Make sure that the end of the key name ends in a `/`
784
+ # for it to be considered a folder.
782
785
  #
783
786
  # </note>
784
787
  #
@@ -792,16 +795,16 @@ module Aws::Transfer
792
795
  # <note markdown="1"> This only applies when domain of ServerId is S3. EFS does not use
793
796
  # scope down policy.
794
797
  #
795
- # For scope-down policies, AWS Transfer Family stores the policy as a
796
- # JSON blob, instead of the Amazon Resource Name (ARN) of the policy.
797
- # You save the policy as a JSON blob and pass it in the `Policy`
798
- # argument.
798
+ # For scope-down policies, Amazon Web Services Transfer Family stores
799
+ # the policy as a JSON blob, instead of the Amazon Resource Name (ARN)
800
+ # of the policy. You save the policy as a JSON blob and pass it in the
801
+ # `Policy` argument.
799
802
  #
800
803
  # For an example of a scope-down policy, see [Example scope-down
801
804
  # policy][1].
802
805
  #
803
- # For more information, see [AssumeRole][2] in the *AWS Security Token
804
- # Service API Reference*.
806
+ # For more information, see [AssumeRole][2] in the *Amazon Web Services
807
+ # Security Token Service API Reference*.
805
808
  #
806
809
  # </note>
807
810
  #
@@ -906,9 +909,9 @@ module Aws::Transfer
906
909
  # A unique identifier that is required to identify specific groups
907
910
  # within your directory. The users of the group that you associate have
908
911
  # access to your Amazon S3 or Amazon EFS resources over the enabled
909
- # protocols using AWS Transfer Family. If you know the group name, you
910
- # can view the SID values by running the following command using Windows
911
- # PowerShell.
912
+ # protocols using Amazon Web Services Transfer Family. If you know the
913
+ # group name, you can view the SID values by running the following
914
+ # command using Windows PowerShell.
912
915
  #
913
916
  # `Get-ADGroup -Filter \{samAccountName -like "YourGroupName*"\}
914
917
  # -Properties * | Select SamAccountName,ObjectSid`
@@ -1047,9 +1050,9 @@ module Aws::Transfer
1047
1050
  # A unique identifier that is required to identify specific groups
1048
1051
  # within your directory. The users of the group that you associate have
1049
1052
  # access to your Amazon S3 or Amazon EFS resources over the enabled
1050
- # protocols using AWS Transfer Family. If you know the group name, you
1051
- # can view the SID values by running the following command using Windows
1052
- # PowerShell.
1053
+ # protocols using Amazon Web Services Transfer Family. If you know the
1054
+ # group name, you can view the SID values by running the following
1055
+ # command using Windows PowerShell.
1053
1056
  #
1054
1057
  # `Get-ADGroup -Filter \{samAccountName -like "YourGroupName*"\}
1055
1058
  # -Properties * | Select SamAccountName,ObjectSid`
@@ -1168,6 +1171,7 @@ module Aws::Transfer
1168
1171
  #
1169
1172
  # resp.server.arn #=> String
1170
1173
  # resp.server.certificate #=> String
1174
+ # resp.server.protocol_details.passive_ip #=> String
1171
1175
  # resp.server.domain #=> String, one of "S3", "EFS"
1172
1176
  # resp.server.endpoint_details.address_allocation_ids #=> Array
1173
1177
  # resp.server.endpoint_details.address_allocation_ids[0] #=> String
@@ -1215,8 +1219,8 @@ module Aws::Transfer
1215
1219
  #
1216
1220
  # @option params [required, String] :user_name
1217
1221
  # The name of the user assigned to one or more servers. User names are
1218
- # part of the sign-in credentials to use the AWS Transfer Family service
1219
- # and perform file transfer tasks.
1222
+ # part of the sign-in credentials to use the Amazon Web Services
1223
+ # Transfer Family service and perform file transfer tasks.
1220
1224
  #
1221
1225
  # @return [Types::DescribeUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1222
1226
  #
@@ -1401,7 +1405,7 @@ module Aws::Transfer
1401
1405
  end
1402
1406
 
1403
1407
  # Lists the file transfer protocol-enabled servers that are associated
1404
- # with your AWS account.
1408
+ # with your Amazon Web Services account.
1405
1409
  #
1406
1410
  # @option params [Integer] :max_results
1407
1411
  # Specifies the number of servers to return as a response to the
@@ -1454,8 +1458,8 @@ module Aws::Transfer
1454
1458
  #
1455
1459
  # @option params [required, String] :arn
1456
1460
  # Requests the tags associated with a particular Amazon Resource Name
1457
- # (ARN). An ARN is an identifier for a specific AWS resource, such as a
1458
- # server, user, or role.
1461
+ # (ARN). An ARN is an identifier for a specific Amazon Web Services
1462
+ # resource, such as a server, user, or role.
1459
1463
  #
1460
1464
  # @option params [Integer] :max_results
1461
1465
  # Specifies the number of tags to return as a response to the
@@ -1629,8 +1633,8 @@ module Aws::Transfer
1629
1633
  # There is no response returned from this call.
1630
1634
  #
1631
1635
  # @option params [required, String] :arn
1632
- # An Amazon Resource Name (ARN) for a specific AWS resource, such as a
1633
- # server, user, or role.
1636
+ # An Amazon Resource Name (ARN) for a specific Amazon Web Services
1637
+ # resource, such as a server, user, or role.
1634
1638
  #
1635
1639
  # @option params [required, Array<Types::Tag>] :tags
1636
1640
  # Key-value pairs assigned to ARNs that you can use to group and search
@@ -1733,8 +1737,8 @@ module Aws::Transfer
1733
1737
  #
1734
1738
  # @option params [required, String] :arn
1735
1739
  # The value of the resource that will have the tag removed. An Amazon
1736
- # Resource Name (ARN) is an identifier for a specific AWS resource, such
1737
- # as a server, user, or role.
1740
+ # Resource Name (ARN) is an identifier for a specific Amazon Web
1741
+ # Services resource, such as a server, user, or role.
1738
1742
  #
1739
1743
  # @option params [required, Array<String>] :tag_keys
1740
1744
  # TagKeys are key-value pairs assigned to ARNs that can be used to group
@@ -1782,11 +1786,11 @@ module Aws::Transfer
1782
1786
  # paths and keys should be visible to your user and how you want to make
1783
1787
  # them visible. You must specify the `Entry` and `Target` pair, where
1784
1788
  # `Entry` shows how the path is made visible and `Target` is the actual
1785
- # Amazon S3 or Amazon EFS path. If you only specify a target, it will be
1786
- # displayed as is. You also must ensure that your AWS Identity and
1787
- # Access Management (IAM) role provides access to paths in `Target`.
1788
- # This value can only be set when `HomeDirectoryType` is set to
1789
- # *LOGICAL*.
1789
+ # Amazon S3 or Amazon EFS path. If you only specify a target, it is
1790
+ # displayed as is. You also must ensure that your Amazon Web Services
1791
+ # Identity and Access Management (IAM) role provides access to paths in
1792
+ # `Target`. This value can only be set when `HomeDirectoryType` is set
1793
+ # to *LOGICAL*.
1790
1794
  #
1791
1795
  # The following is an `Entry` and `Target` pair example.
1792
1796
  #
@@ -1800,19 +1804,16 @@ module Aws::Transfer
1800
1804
  #
1801
1805
  # The following is an `Entry` and `Target` pair example for `chroot`.
1802
1806
  #
1803
- # `[ \{ "Entry": "/", "Target": "/bucket_name/home/mydirectory" \} ]`
1807
+ # `[ \{ "Entry:": "/", "Target": "/bucket_name/home/mydirectory" \} ]`
1804
1808
  #
1805
1809
  # <note markdown="1"> If the target of a logical directory entry does not exist in Amazon S3
1806
- # or Amazon EFS, the entry will be ignored. As a workaround, you can use
1807
- # the Amazon S3 API or EFS API to create 0-byte objects as place holders
1808
- # for your directory. If using the AWS CLI, use the `s3api` or `efsapi`
1809
- # call instead of `s3` or `efs` so you can use the `put-object`
1810
- # operation. For example, you can use the following.
1811
- #
1812
- # `aws s3api put-object --bucket bucketname --key path/to/folder/`
1813
- #
1814
- # The end of the key name must end in a `/` for it to be considered a
1815
- # folder.
1810
+ # or EFS, the entry is ignored. As a workaround, you can use the Amazon
1811
+ # S3 API or EFS API to create 0 byte objects as place holders for your
1812
+ # directory. If using the CLI, use the `s3api` or `efsapi` call instead
1813
+ # of `s3` or `efs` so you can use the put-object operation. For example,
1814
+ # you use the following: `aws s3api put-object --bucket bucketname --key
1815
+ # path/to/folder/`. Make sure that the end of the key name ends in a `/`
1816
+ # for it to be considered a folder.
1816
1817
  #
1817
1818
  # </note>
1818
1819
  #
@@ -1826,16 +1827,16 @@ module Aws::Transfer
1826
1827
  # <note markdown="1"> This only applies when domain of `ServerId` is S3. Amazon EFS does not
1827
1828
  # use scope down policy.
1828
1829
  #
1829
- # For scope-down policies, AWS Transfer Family stores the policy as a
1830
- # JSON blob, instead of the Amazon Resource Name (ARN) of the policy.
1831
- # You save the policy as a JSON blob and pass it in the `Policy`
1832
- # argument.
1830
+ # For scope-down policies, Amazon Web ServicesTransfer Family stores the
1831
+ # policy as a JSON blob, instead of the Amazon Resource Name (ARN) of
1832
+ # the policy. You save the policy as a JSON blob and pass it in the
1833
+ # `Policy` argument.
1833
1834
  #
1834
1835
  # For an example of a scope-down policy, see [Example scope-down
1835
1836
  # policy][1].
1836
1837
  #
1837
- # For more information, see [AssumeRole][2] in the *AWS Security Token
1838
- # Service API Reference*.
1838
+ # For more information, see [AssumeRole][2] in the *Amazon Web
1839
+ # ServicesSecurity Token Service API Reference*.
1839
1840
  #
1840
1841
  # </note>
1841
1842
  #
@@ -1869,9 +1870,9 @@ module Aws::Transfer
1869
1870
  # A unique identifier that is required to identify specific groups
1870
1871
  # within your directory. The users of the group that you associate have
1871
1872
  # access to your Amazon S3 or Amazon EFS resources over the enabled
1872
- # protocols using AWS Transfer Family. If you know the group name, you
1873
- # can view the SID values by running the following command using Windows
1874
- # PowerShell.
1873
+ # protocols using Amazon Web Services Transfer Family. If you know the
1874
+ # group name, you can view the SID values by running the following
1875
+ # command using Windows PowerShell.
1875
1876
  #
1876
1877
  # `Get-ADGroup -Filter \{samAccountName -like "YourGroupName*"\}
1877
1878
  # -Properties * | Select SamAccountName,ObjectSid`
@@ -1932,19 +1933,20 @@ module Aws::Transfer
1932
1933
  # updated.
1933
1934
  #
1934
1935
  # @option params [String] :certificate
1935
- # The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM)
1936
- # certificate. Required when `Protocols` is set to `FTPS`.
1936
+ # The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate
1937
+ # Manager (ACM) certificate. Required when `Protocols` is set to `FTPS`.
1937
1938
  #
1938
1939
  # To request a new public certificate, see [Request a public
1939
- # certificate][1] in the <i> AWS Certificate Manager User Guide</i>.
1940
+ # certificate][1] in the <i> Amazon Web ServicesCertificate Manager User
1941
+ # Guide</i>.
1940
1942
  #
1941
1943
  # To import an existing certificate into ACM, see [Importing
1942
- # certificates into ACM][2] in the <i> AWS Certificate Manager User
1943
- # Guide</i>.
1944
+ # certificates into ACM][2] in the <i> Amazon Web ServicesCertificate
1945
+ # Manager User Guide</i>.
1944
1946
  #
1945
1947
  # To request a private certificate to use FTPS through private IP
1946
- # addresses, see [Request a private certificate][3] in the <i> AWS
1947
- # Certificate Manager User Guide</i>.
1948
+ # addresses, see [Request a private certificate][3] in the <i> Amazon
1949
+ # Web ServicesCertificate Manager User Guide</i>.
1948
1950
  #
1949
1951
  # Certificates with the following cryptographic algorithms and key sizes
1950
1952
  # are supported:
@@ -1970,12 +1972,20 @@ module Aws::Transfer
1970
1972
  # [2]: https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html
1971
1973
  # [3]: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html
1972
1974
  #
1975
+ # @option params [Types::ProtocolDetails] :protocol_details
1976
+ # The protocol settings that are configured for your server.
1977
+ #
1978
+ # Use the `PassiveIp` parameter to indicate passive mode (for FTP and
1979
+ # FTPS protocols). Enter a single dotted-quad IPv4 address, such as the
1980
+ # external IP address of a firewall, router, or load balancer.
1981
+ #
1973
1982
  # @option params [Types::EndpointDetails] :endpoint_details
1974
1983
  # The virtual private cloud (VPC) endpoint settings that are configured
1975
- # for your server. With a VPC endpoint, you can restrict access to your
1976
- # server to resources only within your VPC. To control incoming internet
1977
- # traffic, you will need to associate one or more Elastic IP addresses
1978
- # with your server's endpoint.
1984
+ # for your server. When you host your endpoint within your VPC, you can
1985
+ # make it accessible only to resources within your VPC, or you can
1986
+ # attach Elastic IP addresses and make it accessible to clients over the
1987
+ # internet. Your VPC's default security groups are automatically
1988
+ # assigned to your endpoint.
1979
1989
  #
1980
1990
  # @option params [String] :endpoint_type
1981
1991
  # The type of endpoint that you want your server to use. You can choose
@@ -1986,11 +1996,11 @@ module Aws::Transfer
1986
1996
  # directly to it.
1987
1997
  #
1988
1998
  # <note markdown="1"> After May 19, 2021, you won't be able to create a server using
1989
- # `EndpointType=VPC_ENDPOINT` in your AWS account if your account
1990
- # hasn't already done so before May 19, 2021. If you have already
1991
- # created servers with `EndpointType=VPC_ENDPOINT` in your AWS account
1992
- # on or before May 19, 2021, you will not be affected. After this date,
1993
- # use `EndpointType`=`VPC`.
1999
+ # `EndpointType=VPC_ENDPOINT` in your Amazon Web Servicesaccount if your
2000
+ # account hasn't already done so before May 19, 2021. If you have
2001
+ # already created servers with `EndpointType=VPC_ENDPOINT` in your
2002
+ # Amazon Web Servicesaccount on or before May 19, 2021, you will not be
2003
+ # affected. After this date, use `EndpointType`=`VPC`.
1994
2004
  #
1995
2005
  # For more information, see
1996
2006
  # https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
@@ -2013,7 +2023,7 @@ module Aws::Transfer
2013
2023
  # changing a server's host key can be disruptive.
2014
2024
  #
2015
2025
  # For more information, see [Change the host key for your SFTP-enabled
2016
- # server][1] in the *AWS Transfer Family User Guide*.
2026
+ # server][1] in the *Amazon Web ServicesTransfer Family User Guide*.
2017
2027
  #
2018
2028
  #
2019
2029
  #
@@ -2024,9 +2034,10 @@ module Aws::Transfer
2024
2034
  # customer's authentication API method.
2025
2035
  #
2026
2036
  # @option params [String] :logging_role
2027
- # Changes the AWS Identity and Access Management (IAM) role that allows
2028
- # Amazon S3 or Amazon EFS events to be logged in Amazon CloudWatch,
2029
- # turning logging on or off.
2037
+ # Specifies the Amazon Resource Name (ARN) of the Amazon Web Services
2038
+ # Identity and Access Management (IAM) role that allows a server to turn
2039
+ # on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When
2040
+ # set, user activity can be viewed in your CloudWatch logs.
2030
2041
  #
2031
2042
  # @option params [Array<String>] :protocols
2032
2043
  # Specifies the file transfer protocol or protocols over which your file
@@ -2041,9 +2052,9 @@ module Aws::Transfer
2041
2052
  #
2042
2053
  # * File Transfer Protocol (FTP): Unencrypted file transfer
2043
2054
  #
2044
- # <note markdown="1"> If you select `FTPS`, you must choose a certificate stored in AWS
2045
- # Certificate Manager (ACM) which will be used to identify your server
2046
- # when clients connect to it over FTPS.
2055
+ # <note markdown="1"> If you select `FTPS`, you must choose a certificate stored in Amazon
2056
+ # Web ServicesCertificate Manager (ACM) which will be used to identify
2057
+ # your server when clients connect to it over FTPS.
2047
2058
  #
2048
2059
  # If `Protocol` includes either `FTP` or `FTPS`, then the `EndpointType`
2049
2060
  # must be `VPC` and the `IdentityProviderType` must be
@@ -2074,6 +2085,9 @@ module Aws::Transfer
2074
2085
  #
2075
2086
  # resp = client.update_server({
2076
2087
  # certificate: "Certificate",
2088
+ # protocol_details: {
2089
+ # passive_ip: "PassiveIp",
2090
+ # },
2077
2091
  # endpoint_details: {
2078
2092
  # address_allocation_ids: ["AddressAllocationId"],
2079
2093
  # subnet_ids: ["SubnetId"],
@@ -2132,30 +2146,36 @@ module Aws::Transfer
2132
2146
  # @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings
2133
2147
  # Logical directory mappings that specify what Amazon S3 or Amazon EFS
2134
2148
  # paths and keys should be visible to your user and how you want to make
2135
- # them visible. You will need to specify the "`Entry`" and
2136
- # "`Target`" pair, where `Entry` shows how the path is made visible
2137
- # and `Target` is the actual Amazon S3 or Amazon EFS path. If you only
2138
- # specify a target, it will be displayed as is. You will need to also
2139
- # make sure that your IAM role provides access to paths in `Target`. The
2140
- # following is an example.
2149
+ # them visible. You must specify the `Entry` and `Target` pair, where
2150
+ # `Entry` shows how the path is made visible and `Target` is the actual
2151
+ # Amazon S3 or Amazon EFS path. If you only specify a target, it is
2152
+ # displayed as is. You also must ensure that your Amazon Web Services
2153
+ # Identity and Access Management (IAM) role provides access to paths in
2154
+ # `Target`. This value can only be set when `HomeDirectoryType` is set
2155
+ # to *LOGICAL*.
2141
2156
  #
2142
- # `'[ "/bucket2/documentation", \{ "Entry": "your-personal-report.pdf",
2143
- # "Target": "/bucket3/customized-reports/$\{transfer:UserName\}.pdf" \}
2144
- # ]'`
2157
+ # The following is an `Entry` and `Target` pair example.
2158
+ #
2159
+ # `[ \{ "Entry": "your-personal-report.pdf", "Target":
2160
+ # "/bucket3/customized-reports/$\{transfer:UserName\}.pdf" \} ]`
2145
2161
  #
2146
2162
  # In most cases, you can use this value instead of the scope-down policy
2147
2163
  # to lock down your user to the designated home directory
2148
2164
  # ("`chroot`"). To do this, you can set `Entry` to '/' and set
2149
2165
  # `Target` to the HomeDirectory parameter value.
2150
2166
  #
2167
+ # The following is an `Entry` and `Target` pair example for `chroot`.
2168
+ #
2169
+ # `[ \{ "Entry:": "/", "Target": "/bucket_name/home/mydirectory" \} ]`
2170
+ #
2151
2171
  # <note markdown="1"> If the target of a logical directory entry does not exist in Amazon S3
2152
- # or EFS, the entry will be ignored. As a workaround, you can use the
2153
- # Amazon S3 API or EFS API to create 0-byte objects as place holders for
2154
- # your directory. If using the AWS CLI, use the `s3api` or `efsapi` call
2155
- # instead of `s3` `efs` so you can use the put-object operation. For
2156
- # example, you use the following: `aws s3api put-object --bucket
2157
- # bucketname --key path/to/folder/`. Make sure that the end of the key
2158
- # name ends in a / for it to be considered a folder.
2172
+ # or EFS, the entry is ignored. As a workaround, you can use the Amazon
2173
+ # S3 API or EFS API to create 0 byte objects as place holders for your
2174
+ # directory. If using the CLI, use the `s3api` or `efsapi` call instead
2175
+ # of `s3` or `efs` so you can use the put-object operation. For example,
2176
+ # you use the following: `aws s3api put-object --bucket bucketname --key
2177
+ # path/to/folder/`. Make sure that the end of the key name ends in a `/`
2178
+ # for it to be considered a folder.
2159
2179
  #
2160
2180
  # </note>
2161
2181
  #
@@ -2169,16 +2189,16 @@ module Aws::Transfer
2169
2189
  # <note markdown="1"> This only applies when domain of `ServerId` is S3. Amazon EFS does not
2170
2190
  # use scope-down policies.
2171
2191
  #
2172
- # For scope-down policies, AWS Transfer Family stores the policy as a
2173
- # JSON blob, instead of the Amazon Resource Name (ARN) of the policy.
2174
- # You save the policy as a JSON blob and pass it in the `Policy`
2175
- # argument.
2192
+ # For scope-down policies, Amazon Web ServicesTransfer Family stores the
2193
+ # policy as a JSON blob, instead of the Amazon Resource Name (ARN) of
2194
+ # the policy. You save the policy as a JSON blob and pass it in the
2195
+ # `Policy` argument.
2176
2196
  #
2177
2197
  # For an example of a scope-down policy, see [Creating a scope-down
2178
2198
  # policy][1].
2179
2199
  #
2180
- # For more information, see [AssumeRole][2] in the *AWS Security Token
2181
- # Service API Reference*.
2200
+ # For more information, see [AssumeRole][2] in the *Amazon Web Services
2201
+ # Security Token Service API Reference*.
2182
2202
  #
2183
2203
  # </note>
2184
2204
  #
@@ -2270,7 +2290,7 @@ module Aws::Transfer
2270
2290
  params: params,
2271
2291
  config: config)
2272
2292
  context[:gem_name] = 'aws-sdk-transfer'
2273
- context[:gem_version] = '1.34.0'
2293
+ context[:gem_version] = '1.35.0'
2274
2294
  Seahorse::Client::Request.new(handlers, context)
2275
2295
  end
2276
2296