NAME
Paws::Transfer::DescribedServer
USAGE
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::DescribedServer 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::DescribedServer object:
$result = $service_obj->Method(...);
$result->Att1->ArnDESCRIPTION
Describes the properties of the server that was specified. Information returned includes the following: the server Amazon Resource Name (ARN), the authentication configuration and type, the logging role, the server ID and state, and assigned tags or metadata.
ATTRIBUTES
REQUIRED Arn => Str
Specifies the unique Amazon Resource Name (ARN) for the server to be described.
EndpointDetails => Paws::Transfer::EndpointDetails
The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
EndpointType => Str
The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
HostKeyFingerprint => Str
This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
IdentityProviderDetails => Paws::Transfer::IdentityProviderDetails
Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
IdentityProviderType => Str
This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
LoggingRole => Str
This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
ServerId => Str
This property is a unique system-assigned identifier for the SFTP server that you instantiate.
State => Str
The condition of the SFTP 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.
Tags => ArrayRef[Paws::Transfer::Tag]
This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
UserCount => Int
The number of users that are assigned to the SFTP server you specified with the ServerId.
SEE ALSO
This class forms part of Paws, describing an object used in Paws::Transfer
BUGS and CONTRIBUTIONS
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