Class: Aws::Transfer::Types::UpdateServerRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-transfer/types.rb

Overview

Note:

When making an API call, you may pass UpdateServerRequest 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, VPC_ENDPOINT
  host_key: "HostKey",
  identity_provider_details: {
    url: "Url",
    invocation_role: "Role",
  },
  logging_role: "NullableRole",
  server_id: "ServerId", # required
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#endpoint_details ⇒ Types::EndpointDetails

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 associate one or more Elastic IP addresses with your server’s endpoint.

Returns:



1461
1462
1463
1464
1465
1466
1467
1468
1469
 
# File 'lib/aws-sdk-transfer/types.rb', line 1461

class UpdateServerRequest < Struct.new(
  :endpoint_details,
  :endpoint_type,
  :host_key,
  :identity_provider_details,
  :logging_role,
  :server_id)
  include Aws::Structure
end

#endpoint_type ⇒ String

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 accessible over the public internet.

Returns:

  • (String) 


1461
1462
1463
1464
1465
1466
1467
1468
1469
 
# File 'lib/aws-sdk-transfer/types.rb', line 1461

class UpdateServerRequest < Struct.new(
  :endpoint_details,
  :endpoint_type,
  :host_key,
  :identity_provider_details,
  :logging_role,
  :server_id)
  include Aws::Structure
end

#host_key ⇒ String

The RSA private key as generated by ‘ssh-keygen -N “” -f my-new-server-key`.

If you aren’t planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don’t update the host key. Accidentally changing a server’s host key can be disruptive.

For more information, see “docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key” in the *AWS SFTP User Guide.*

Returns:

  • (String) 


1461
1462
1463
1464
1465
1466
1467
1468
1469
 
# File 'lib/aws-sdk-transfer/types.rb', line 1461

class UpdateServerRequest < Struct.new(
  :endpoint_details,
  :endpoint_type,
  :host_key,
  :identity_provider_details,
  :logging_role,
  :server_id)
  include Aws::Structure
end

#identity_provider_details ⇒ Types::IdentityProviderDetails

This response parameter is an array containing all of the information required to call a customer’s authentication API method.

Returns:



1461
1462
1463
1464
1465
1466
1467
1468
1469
 
# File 'lib/aws-sdk-transfer/types.rb', line 1461

class UpdateServerRequest < Struct.new(
  :endpoint_details,
  :endpoint_type,
  :host_key,
  :identity_provider_details,
  :logging_role,
  :server_id)
  include Aws::Structure
end

#logging_role ⇒ String

A value that changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

Returns:

  • (String) 


1461
1462
1463
1464
1465
1466
1467
1468
1469
 
# File 'lib/aws-sdk-transfer/types.rb', line 1461

class UpdateServerRequest < Struct.new(
  :endpoint_details,
  :endpoint_type,
  :host_key,
  :identity_provider_details,
  :logging_role,
  :server_id)
  include Aws::Structure
end

#server_id ⇒ String

A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

Returns:

  • (String) 


1461
1462
1463
1464
1465
1466
1467
1468
1469
 
# File 'lib/aws-sdk-transfer/types.rb', line 1461

class UpdateServerRequest < Struct.new(
  :endpoint_details,
  :endpoint_type,
  :host_key,
  :identity_provider_details,
  :logging_role,
  :server_id)
  include Aws::Structure
end