Struct DescribedServer 

pub struct DescribedServer {

    pub arn: String,
    pub certificate: Option<String>,
    pub endpoint_details: Option<EndpointDetails>,
    pub endpoint_type: Option<String>,
    pub host_key_fingerprint: Option<String>,
    pub identity_provider_details: Option<IdentityProviderDetails>,
    pub identity_provider_type: Option<String>,
    pub logging_role: Option<String>,
    pub protocols: Option<Vec<String>>,
    pub server_id: Option<String>,
    pub state: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub user_count: Option<i64>,
}

Describes the properties of a file transfer protocol-enabled server that was specified. Information returned includes the following: the server Amazon Resource Name (ARN), the certificate ARN (if the FTPS protocol was selected), the endpoint type and details, the authentication configuration and type, the logging role, the file transfer protocol or protocols, the server ID and state, and assigned tags or metadata.

Fields

arn: String

Specifies the unique Amazon Resource Name (ARN) for a file transfer protocol-enabled server to be described.

certificate: Option<String>

Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

endpoint_details: Option<EndpointDetails>

Specifies the virtual private cloud (VPC) endpoint settings that you configured for your file transfer protocol-enabled server.

endpoint_type: Option<String>

Defines the type of endpoint that your file transfer protocol-enabled server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.

host_key_fingerprint: Option<String>

Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output of the ssh-keygen -l -f my-new-server-key command.

identity_provider_details: Option<IdentityProviderDetails>

Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a file transfer protocol-enabled server is SERVICE_MANAGED.

identity_provider_type: Option<String>

Specifies the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this file transfer protocol-enabled server to store and access 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.

logging_role: Option<String>

Specifies the AWS Identity and Access Management (IAM) role that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.

protocols: Option<Vec<String>>

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

• SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH

• FTPS (File Transfer Protocol Secure): File transfer with TLS encryption

• FTP (File Transfer Protocol): Unencrypted file transfer

server_id: Option<String>

Specifies the unique system-assigned identifier for a file transfer protocol-enabled server that you instantiate.

state: Option<String>

Specifies the condition of a file transfer protocol-enabled 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: Option<Vec<Tag>>

Specifies the key-value pairs that you can use to search for and group file transfer protocol-enabled servers that were assigned to the server that was described.

user_count: Option<i64>

Specifies the number of users that are assigned to a file transfer protocol-enabled server you specified with the ServerId.

Trait Implementations

impl Clone for DescribedServer

fn clone(&self) -> DescribedServer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribedServer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DescribedServer

fn default() -> DescribedServer

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DescribedServer

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DescribedServer

fn eq(&self, other: &DescribedServer) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DescribedServer