You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateServerRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  endpoint_details: {
    vpc_endpoint_id: "VpcEndpointId",
  },
  endpoint_type: "PUBLIC", # accepts PUBLIC, VPC_ENDPOINT
  host_key: "HostKey",
  identity_provider_details: {
    url: "Url",
    invocation_role: "Role",
  },
  logging_role: "NullableRole",
  server_id: "ServerId", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#endpoint_detailsTypes::EndpointDetails

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.

Returns:

  • (Types::EndpointDetails)

    The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server.

#endpoint_typeString

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.

Possible values:

  • PUBLIC
  • VPC_ENDPOINT

Returns:

  • (String)

    The type of endpoint that you want your SFTP server to connect to.

#host_keyString

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 \"https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key%22 in the AWS SFTP User Guide.

Returns:

  • (String)

    The RSA private key as generated by ssh-keygen -N "" -f my-new-server-key.

#identity_provider_detailsTypes::IdentityProviderDetails

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

Returns:

  • (Types::IdentityProviderDetails)

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

#logging_roleString

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)

    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.

#server_idString

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

Returns:

  • (String)

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