GSP
Quick Navigator
Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::Transfer::ListedServer(3) User Contributed Perl Documentation Paws::Transfer::ListedServer(3)

Paws::Transfer::ListedServer

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Transfer::ListedServer object:

  $service_obj->Method(Att1 => { Arn => $value, ..., UserCount => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Transfer::ListedServer object:

  $result = $service_obj->Method(...);
  $result->Att1->Arn

Returns properties of a file transfer protocol-enabled server that was specified.

REQUIRED Arn => Str

Specifies the unique Amazon Resource Name (ARN) for a server to be listed.

Specifies the domain of the storage system that is used for file transfers.

Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.

Specifies the mode of authentication for a server. The default value is "SERVICE_MANAGED", which allows you to store and access user credentials within the Amazon Web Services Transfer Family service.

Use "AWS_DIRECTORY_SERVICE" to provide access to Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to provide a Directory ID using the "IdentityProviderDetails" parameter.

Use the "API_GATEWAY" value to integrate with an identity provider of your choosing. The "API_GATEWAY" setting requires you to provide an API Gateway endpoint URL to call for authentication using the "IdentityProviderDetails" parameter.

Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.

Specifies the unique system assigned identifier for the servers that were listed.

Specifies the condition of a server for the server that was described. A value of "ONLINE" indicates that the server can accept jobs and transfer files. A "State" value of "OFFLINE" means that the server cannot perform file transfer operations.

The states of "STARTING" and "STOPPING" indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of "START_FAILED" or "STOP_FAILED" can indicate an error condition.

Specifies the number of users that are assigned to a server you specified with the "ServerId".

This class forms part of Paws, describing an object used in Paws::Transfer

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2
Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.