lib/aws-sdk-transfer/client.rb in aws-sdk-transfer-1.15.0 vs lib/aws-sdk-transfer/client.rb in aws-sdk-transfer-1.16.0

- old
+ new

@@ -268,18 +268,21 @@ # Transfer Protocol (SFTP) in AWS. When you make updates to your server # or when you work with users, use the service-generated `ServerId` # 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 # my-new-server-key` command. # @@ -320,13 +323,16 @@ # # @example Request syntax with placeholder values # # 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", # invocation_role: "Role", # }, @@ -392,10 +398,20 @@ # In most cases, you can use this value instead of the scope down 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> + # # @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 # of their Amazon S3 bucket. Variables that you can use inside this # policy include `$\{Transfer:UserName\}`, @@ -580,11 +596,13 @@ end # 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. # # @return [Types::DescribeServerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -598,12 +616,17 @@ # }) # # @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 # resp.server.identity_provider_type #=> String, one of "SERVICE_MANAGED", "API_GATEWAY" # resp.server.logging_role #=> String @@ -753,11 +776,11 @@ # # resp.next_token #=> String # 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" # resp.servers[0].user_count #=> Integer # @@ -1061,12 +1084,14 @@ # The `UpdateServer` call returns the `ServerId` of the Secure File # Transfer Protocol (SFTP) server you updated. # # @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 # can choose to connect to the public internet or a virtual private # cloud (VPC) endpoint. With a VPC endpoint, your SFTP server isn't @@ -1103,13 +1128,16 @@ # # @example Request syntax with placeholder values # # 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", # invocation_role: "Role", # }, @@ -1167,10 +1195,20 @@ # In most cases, you can use this value instead of the scope down 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> + # # @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 # users. The policy scopes down user access to portions of your Amazon # S3 bucket. Variables you can use inside this policy include @@ -1260,10 +1298,10 @@ operation: config.api.operation(operation_name), client: self, 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 # @api private # @deprecated