aws-sdk-transfer 1.15.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 640f4f4d43eb97008366aea349e471a7ec69b1e3
-  data.tar.gz: 2b8ba0c1a8dcd6d87cddd7f6fb3e41549fa0b40b
+  metadata.gz: a3cd7c542cb28a93bf0941b472319129cc139f56
+  data.tar.gz: 57a2ed8cc1a05c0eefa50492a1f4254348aac9d3
 SHA512:
-  metadata.gz: 1acd1ed522cc99b0608011624e750c1805eef04e2ad86f42dad100834eaaf2ba8e7c8b7a34db04e35d6e319181a8246fe5207a2b6b84c573818c9d54f26cf23c
-  data.tar.gz: eeb3e5a1d74130be87048906d6845253bf96c9414a9cc8fd7b958d23ec8ad568dd62c48aa1be5621949d36a66521b379c54452f1a899e581dce298d32332324b
+  metadata.gz: 62ddd3eab3a8ee29c2fb1c47ad22a03e89d290b7ef07d30e85606aad5d37972383ebb09bda13c7341cffcd0f6b9492043f40302dd6bd15b02fb82ea90e5ca423
+  data.tar.gz: 00ba9c719d7aee275596b10ed2dbf6ed5e1b447b140b28d3038fe3e6c733ab7c4a834d7b9a3cfdc2ca64024507f129027ba138464119266820e76b673b7fee67

data/lib/aws-sdk-transfer.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-transfer/customizations'
 # @service
 module Aws::Transfer
 
-  GEM_VERSION = '1.15.0'
+  GEM_VERSION = '1.16.0'
 
 end

data/lib/aws-sdk-transfer/client.rb

@@ -270,14 +270,17 @@ module Aws::Transfer
     # property that is assigned to the newly created server.
     #
     # @option params [Types::EndpointDetails] :endpoint_details
-    #   The virtual private cloud (VPC) endpoint settings that you want to
-    #   configure for your SFTP server. This parameter is required when you
-    #   specify a value for the `EndpointType` parameter.
+    #   The virtual private cloud (VPC) endpoint settings that are configured
+    #   for your SFTP server. With a VPC endpoint, you can restrict access to
+    #   your SFTP server to resources only within your VPC. To control
+    #   incoming internet traffic, you will need to invoke the `UpdateServer`
+    #   API and attach an Elastic IP to your server's endpoint.
     #
     # @option params [String] :endpoint_type
     #   The type of VPC endpoint that you want your SFTP server to connect to.
-    #   If you connect to a VPC endpoint, your SFTP server isn't accessible
-    #   over the public internet.
+    #   You can choose to connect to the public internet or a virtual private
+    #   cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to
+    #   your SFTP server and resources only within your VPC.
     #
     # @option params [String] :host_key
     #   The RSA private key as generated by the `ssh-keygen -N "" -f
@@ -322,9 +325,12 @@ module Aws::Transfer
     #
     #   resp = client.create_server({
     #     endpoint_details: {
+    #       address_allocation_ids: ["AddressAllocationId"],
+    #       subnet_ids: ["SubnetId"],
     #       vpc_endpoint_id: "VpcEndpointId",
+    #       vpc_id: "VpcId",
     #     },
-    #     endpoint_type: "PUBLIC", # accepts PUBLIC, VPC_ENDPOINT
+    #     endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
     #     host_key: "HostKey",
     #     identity_provider_details: {
     #       url: "Url",
@@ -394,6 +400,16 @@ module Aws::Transfer
     #   To do this, you can set `Entry` to '/' and set `Target` to the
     #   HomeDirectory parameter value.
     #
+    #   <note markdown="1"> If the target of a logical directory entry does not exist in S3, the
+    #   entry will be ignored. As a workaround, you can use the S3 api to
+    #   create 0 byte objects as place holders for your directory. If using
+    #   the CLI, use the s3api call instead of s3 so you can use the
+    #   put-object operation. For example, you use the following: `aws s3api
+    #   put-object --bucket bucketname --key path/to/folder/`. Make sure that
+    #   the end of the key name ends in a / for it to be considered a folder.
+    #
+    #    </note>
+    #
     # @option params [String] :policy
     #   A scope-down policy for your user so you can use the same IAM role
     #   across multiple users. This policy scopes down user access to portions
@@ -582,7 +598,9 @@ module Aws::Transfer
     # Describes the server that you specify by passing the `ServerId`
     # parameter.
     #
-    # The response contains a description of the server's properties.
+    # The response contains a description of the server's properties. When
+    # you set `EndpointType` to VPC, the response will contain the
+    # `EndpointDetails`.
     #
     # @option params [required, String] :server_id
     #   A system-assigned unique identifier for an SFTP server.
@@ -600,8 +618,13 @@ module Aws::Transfer
     # @example Response structure
     #
     #   resp.server.arn #=> String
+    #   resp.server.endpoint_details.address_allocation_ids #=> Array
+    #   resp.server.endpoint_details.address_allocation_ids[0] #=> String
+    #   resp.server.endpoint_details.subnet_ids #=> Array
+    #   resp.server.endpoint_details.subnet_ids[0] #=> String
     #   resp.server.endpoint_details.vpc_endpoint_id #=> String
-    #   resp.server.endpoint_type #=> String, one of "PUBLIC", "VPC_ENDPOINT"
+    #   resp.server.endpoint_details.vpc_id #=> String
+    #   resp.server.endpoint_type #=> String, one of "PUBLIC", "VPC", "VPC_ENDPOINT"
     #   resp.server.host_key_fingerprint #=> String
     #   resp.server.identity_provider_details.url #=> String
     #   resp.server.identity_provider_details.invocation_role #=> String
@@ -755,7 +778,7 @@ module Aws::Transfer
     #   resp.servers #=> Array
     #   resp.servers[0].arn #=> String
     #   resp.servers[0].identity_provider_type #=> String, one of "SERVICE_MANAGED", "API_GATEWAY"
-    #   resp.servers[0].endpoint_type #=> String, one of "PUBLIC", "VPC_ENDPOINT"
+    #   resp.servers[0].endpoint_type #=> String, one of "PUBLIC", "VPC", "VPC_ENDPOINT"
     #   resp.servers[0].logging_role #=> String
     #   resp.servers[0].server_id #=> String
     #   resp.servers[0].state #=> String, one of "OFFLINE", "ONLINE", "STARTING", "STOPPING", "START_FAILED", "STOP_FAILED"
@@ -1063,8 +1086,10 @@ module Aws::Transfer
     #
     # @option params [Types::EndpointDetails] :endpoint_details
     #   The virtual private cloud (VPC) endpoint settings that are configured
-    #   for your SFTP server. With a VPC endpoint, your SFTP server isn't
-    #   accessible over the public internet.
+    #   for your SFTP server. With a VPC endpoint, you can restrict access to
+    #   your SFTP server to resources only within your VPC. To control
+    #   incoming internet traffic, you will need to associate one or more
+    #   Elastic IP addresses with your server's endpoint.
     #
     # @option params [String] :endpoint_type
     #   The type of endpoint that you want your SFTP server to connect to. You
@@ -1105,9 +1130,12 @@ module Aws::Transfer
     #
     #   resp = client.update_server({
     #     endpoint_details: {
+    #       address_allocation_ids: ["AddressAllocationId"],
+    #       subnet_ids: ["SubnetId"],
     #       vpc_endpoint_id: "VpcEndpointId",
+    #       vpc_id: "VpcId",
     #     },
-    #     endpoint_type: "PUBLIC", # accepts PUBLIC, VPC_ENDPOINT
+    #     endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
     #     host_key: "HostKey",
     #     identity_provider_details: {
     #       url: "Url",
@@ -1169,6 +1197,16 @@ module Aws::Transfer
     #   To do this, you can set `Entry` to '/' and set `Target` to the
     #   HomeDirectory parameter value.
     #
+    #   <note markdown="1"> If the target of a logical directory entry does not exist in S3, the
+    #   entry will be ignored. As a workaround, you can use the S3 api to
+    #   create 0 byte objects as place holders for your directory. If using
+    #   the CLI, use the s3api call instead of s3 so you can use the
+    #   put-object operation. For example, you use the following: `aws s3api
+    #   put-object --bucket bucketname --key path/to/folder/`. Make sure that
+    #   the end of the key name ends in a / for it to be considered a folder.
+    #
+    #    </note>
+    #
     # @option params [String] :policy
     #   Allows you to supply a scope-down policy for your user so you can use
     #   the same AWS Identity and Access Management (IAM) role across multiple
@@ -1262,7 +1300,7 @@ module Aws::Transfer
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-transfer'
-      context[:gem_version] = '1.15.0'
+      context[:gem_version] = '1.16.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-transfer/client_api.rb

@@ -11,7 +11,10 @@ module Aws::Transfer
 
     include Seahorse::Model
 
+    AddressAllocationId = Shapes::StringShape.new(name: 'AddressAllocationId')
+    AddressAllocationIds = Shapes::ListShape.new(name: 'AddressAllocationIds')
     Arn = Shapes::StringShape.new(name: 'Arn')
+    ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
     CreateServerRequest = Shapes::StructureShape.new(name: 'CreateServerRequest')
     CreateServerResponse = Shapes::StructureShape.new(name: 'CreateServerResponse')
     CreateUserRequest = Shapes::StructureShape.new(name: 'CreateUserRequest')
@@ -77,6 +80,8 @@ module Aws::Transfer
     State = Shapes::StringShape.new(name: 'State')
     StatusCode = Shapes::IntegerShape.new(name: 'StatusCode')
     StopServerRequest = Shapes::StructureShape.new(name: 'StopServerRequest')
+    SubnetId = Shapes::StringShape.new(name: 'SubnetId')
+    SubnetIds = Shapes::ListShape.new(name: 'SubnetIds')
     Tag = Shapes::StructureShape.new(name: 'Tag')
     TagKey = Shapes::StringShape.new(name: 'TagKey')
     TagKeys = Shapes::ListShape.new(name: 'TagKeys')
@@ -96,6 +101,12 @@ module Aws::Transfer
     UserName = Shapes::StringShape.new(name: 'UserName')
     UserPassword = Shapes::StringShape.new(name: 'UserPassword')
     VpcEndpointId = Shapes::StringShape.new(name: 'VpcEndpointId')
+    VpcId = Shapes::StringShape.new(name: 'VpcId')
+
+    AddressAllocationIds.member = Shapes::ShapeRef.new(shape: AddressAllocationId)
+
+    ConflictException.add_member(:message, Shapes::ShapeRef.new(shape: Message, required: true, location_name: "Message"))
+    ConflictException.struct_class = Types::ConflictException
 
     CreateServerRequest.add_member(:endpoint_details, Shapes::ShapeRef.new(shape: EndpointDetails, location_name: "EndpointDetails"))
     CreateServerRequest.add_member(:endpoint_type, Shapes::ShapeRef.new(shape: EndpointType, location_name: "EndpointType"))
@@ -174,7 +185,10 @@ module Aws::Transfer
     DescribedUser.add_member(:user_name, Shapes::ShapeRef.new(shape: UserName, location_name: "UserName"))
     DescribedUser.struct_class = Types::DescribedUser
 
+    EndpointDetails.add_member(:address_allocation_ids, Shapes::ShapeRef.new(shape: AddressAllocationIds, location_name: "AddressAllocationIds"))
+    EndpointDetails.add_member(:subnet_ids, Shapes::ShapeRef.new(shape: SubnetIds, location_name: "SubnetIds"))
     EndpointDetails.add_member(:vpc_endpoint_id, Shapes::ShapeRef.new(shape: VpcEndpointId, location_name: "VpcEndpointId"))
+    EndpointDetails.add_member(:vpc_id, Shapes::ShapeRef.new(shape: VpcId, location_name: "VpcId"))
     EndpointDetails.struct_class = Types::EndpointDetails
 
     HomeDirectoryMapEntry.add_member(:entry, Shapes::ShapeRef.new(shape: MapEntry, required: true, location_name: "Entry"))
@@ -281,6 +295,8 @@ module Aws::Transfer
     StopServerRequest.add_member(:server_id, Shapes::ShapeRef.new(shape: ServerId, required: true, location_name: "ServerId"))
     StopServerRequest.struct_class = Types::StopServerRequest
 
+    SubnetIds.member = Shapes::ShapeRef.new(shape: SubnetId)
+
     Tag.add_member(:key, Shapes::ShapeRef.new(shape: TagKey, required: true, location_name: "Key"))
     Tag.add_member(:value, Shapes::ShapeRef.new(shape: TagValue, required: true, location_name: "Value"))
     Tag.struct_class = Types::Tag
@@ -579,6 +595,7 @@ module Aws::Transfer
         o.input = Shapes::ShapeRef.new(shape: UpdateServerRequest)
         o.output = Shapes::ShapeRef.new(shape: UpdateServerResponse)
         o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
+        o.errors << Shapes::ShapeRef.new(shape: ConflictException)
         o.errors << Shapes::ShapeRef.new(shape: InternalServiceError)
         o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
         o.errors << Shapes::ShapeRef.new(shape: ResourceExistsException)

data/lib/aws-sdk-transfer/errors.rb

@@ -10,6 +10,22 @@ module Aws::Transfer
 
     extend Aws::Errors::DynamicErrors
 
+    class ConflictException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::Transfer::Types::ConflictException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+
+    end
+
     class InternalServiceError < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context

data/lib/aws-sdk-transfer/types.rb

@@ -8,14 +8,31 @@
 module Aws::Transfer
   module Types
 
+    # This exception is thrown when the `UpdatServer` is called for a server
+    # that has VPC as the endpoint type and the server's `VpcEndpointID` is
+    # not in the available state.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ConflictException AWS API Documentation
+    #
+    class ConflictException < Struct.new(
+      :message)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass CreateServerRequest
     #   data as a hash:
     #
     #       {
     #         endpoint_details: {
+    #           address_allocation_ids: ["AddressAllocationId"],
+    #           subnet_ids: ["SubnetId"],
     #           vpc_endpoint_id: "VpcEndpointId",
+    #           vpc_id: "VpcId",
     #         },
-    #         endpoint_type: "PUBLIC", # accepts PUBLIC, VPC_ENDPOINT
+    #         endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
     #         host_key: "HostKey",
     #         identity_provider_details: {
     #           url: "Url",
@@ -32,15 +49,19 @@ module Aws::Transfer
     #       }
     #
     # @!attribute [rw] endpoint_details
-    #   The virtual private cloud (VPC) endpoint settings that you want to
-    #   configure for your SFTP server. This parameter is required when you
-    #   specify a value for the `EndpointType` parameter.
+    #   The virtual private cloud (VPC) endpoint settings that are
+    #   configured for your SFTP server. With a VPC endpoint, you can
+    #   restrict access to your SFTP server to resources only within your
+    #   VPC. To control incoming internet traffic, you will need to invoke
+    #   the `UpdateServer` API and attach an Elastic IP to your server's
+    #   endpoint.
     #   @return [Types::EndpointDetails]
     #
     # @!attribute [rw] endpoint_type
     #   The type of VPC endpoint that you want your SFTP server to connect
-    #   to. If you connect to a VPC endpoint, your SFTP server isn't
-    #   accessible over the public internet.
+    #   to. You can choose to connect to the public internet or a virtual
+    #   private cloud (VPC) endpoint. With a VPC endpoint, you can restrict
+    #   access to your SFTP server and resources only within your VPC.
     #   @return [String]
     #
     # @!attribute [rw] host_key
@@ -166,6 +187,17 @@ module Aws::Transfer
     #   policy to lock your user down to the designated home directory
     #   ("chroot"). To do this, you can set `Entry` to '/' and set
     #   `Target` to the HomeDirectory parameter value.
+    #
+    #   <note markdown="1"> If the target of a logical directory entry does not exist in S3, the
+    #   entry will be ignored. As a workaround, you can use the S3 api to
+    #   create 0 byte objects as place holders for your directory. If using
+    #   the CLI, use the s3api call instead of s3 so you can use the
+    #   put-object operation. For example, you use the following: `aws s3api
+    #   put-object --bucket bucketname --key path/to/folder/`. Make sure
+    #   that the end of the key name ends in a / for it to be considered a
+    #   folder.
+    #
+    #    </note>
     #   @return [Array<Types::HomeDirectoryMapEntry>]
     #
     # @!attribute [rw] policy
@@ -591,24 +623,53 @@ module Aws::Transfer
       include Aws::Structure
     end
 
-    # The configuration settings for the virtual private cloud (VPC)
-    # endpoint for your SFTP server.
+    # The virtual private cloud (VPC) endpoint settings that are configured
+    # for your SFTP server. With a VPC endpoint, you can restrict access to
+    # your SFTP server and resources only within your VPC. To control
+    # incoming internet traffic, invoke the `UpdateServer` API and attach an
+    # Elastic IP to your server's endpoint.
     #
     # @note When making an API call, you may pass EndpointDetails
     #   data as a hash:
     #
     #       {
+    #         address_allocation_ids: ["AddressAllocationId"],
+    #         subnet_ids: ["SubnetId"],
     #         vpc_endpoint_id: "VpcEndpointId",
+    #         vpc_id: "VpcId",
     #       }
     #
+    # @!attribute [rw] address_allocation_ids
+    #   A list of address allocation IDs that are required to attach an
+    #   Elastic IP address to your SFTP server's endpoint. This is only
+    #   valid in the `UpdateServer` API.
+    #
+    #   <note markdown="1"> This property can only be use when `EndpointType` is set to `VPC`.
+    #
+    #    </note>
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] subnet_ids
+    #   A list of subnet IDs that are required to host your SFTP server
+    #   endpoint in your VPC.
+    #   @return [Array<String>]
+    #
     # @!attribute [rw] vpc_endpoint_id
     #   The ID of the VPC endpoint.
     #   @return [String]
     #
+    # @!attribute [rw] vpc_id
+    #   The VPC ID of the virtual private cloud in which the SFTP server's
+    #   endpoint will be hosted.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/EndpointDetails AWS API Documentation
     #
     class EndpointDetails < Struct.new(
-      :vpc_endpoint_id)
+      :address_allocation_ids,
+      :subnet_ids,
+      :vpc_endpoint_id,
+      :vpc_id)
       include Aws::Structure
     end
 
@@ -1334,9 +1395,12 @@ module Aws::Transfer
     #
     #       {
     #         endpoint_details: {
+    #           address_allocation_ids: ["AddressAllocationId"],
+    #           subnet_ids: ["SubnetId"],
     #           vpc_endpoint_id: "VpcEndpointId",
+    #           vpc_id: "VpcId",
     #         },
-    #         endpoint_type: "PUBLIC", # accepts PUBLIC, VPC_ENDPOINT
+    #         endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
     #         host_key: "HostKey",
     #         identity_provider_details: {
     #           url: "Url",
@@ -1348,8 +1412,11 @@ module Aws::Transfer
     #
     # @!attribute [rw] endpoint_details
     #   The virtual private cloud (VPC) endpoint settings that are
-    #   configured for your SFTP server. With a VPC endpoint, your SFTP
-    #   server isn't accessible over the public internet.
+    #   configured for your SFTP server. With a VPC endpoint, you can
+    #   restrict access to your SFTP server to resources only within your
+    #   VPC. To control incoming internet traffic, you will need to
+    #   associate one or more Elastic IP addresses with your server's
+    #   endpoint.
     #   @return [Types::EndpointDetails]
     #
     # @!attribute [rw] endpoint_type
@@ -1465,6 +1532,17 @@ module Aws::Transfer
     #   policy to lock your user down to the designated home directory
     #   ("chroot"). To do this, you can set `Entry` to '/' and set
     #   `Target` to the HomeDirectory parameter value.
+    #
+    #   <note markdown="1"> If the target of a logical directory entry does not exist in S3, the
+    #   entry will be ignored. As a workaround, you can use the S3 api to
+    #   create 0 byte objects as place holders for your directory. If using
+    #   the CLI, use the s3api call instead of s3 so you can use the
+    #   put-object operation. For example, you use the following: `aws s3api
+    #   put-object --bucket bucketname --key path/to/folder/`. Make sure
+    #   that the end of the key name ends in a / for it to be considered a
+    #   folder.
+    #
+    #    </note>
     #   @return [Array<Types::HomeDirectoryMapEntry>]
     #
     # @!attribute [rw] policy

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-transfer
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.16.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-28 00:00:00.000000000 Z
+date: 2020-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core