ListedServer

public struct ListedServer : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]
  • arn

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

    Declaration

    Swift

    public let arn: String

  • Specifies the type of VPC 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.

    Declaration

    Swift

    public let endpointType: EndpointType?

  • Specifies the authentication method used to validate a user for a file transfer protocol-enabled server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.

    Declaration

    Swift

    public let identityProviderType: IdentityProviderType?

  • Specifies the AWS Identity and Access Management (IAM) role that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging.

    Declaration

    Swift

    public let loggingRole: String?

  • Specifies the unique system assigned identifier for a file transfer protocol-enabled servers that were listed.

    Declaration

    Swift

    public let serverId: 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.

    Declaration

    Swift

    public let state: State?

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

    Declaration

    Swift

    public let userCount: Int?

  • Undocumented

    Declaration

    Swift

    public init(arn: String, endpointType: EndpointType? = nil, identityProviderType: IdentityProviderType? = nil, loggingRole: String? = nil, serverId: String? = nil, state: State? = nil, userCount: Int? = nil)