DescribedServer

public struct DescribedServer : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]
  • arn

    Specifies the unique Amazon Resource Name (ARN) of the file transfer protocol-enabled server.

    Declaration

    Swift

    public let arn: String

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

    Declaration

    Swift

    public let certificate: String?

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

    Declaration

    Swift

    public let endpointDetails: EndpointDetails?

  • 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.

    Declaration

    Swift

    public let endpointType: EndpointType?

  • 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.

    Declaration

    Swift

    public let hostKeyFingerprint: String?

  • 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.

    Declaration

    Swift

    public let identityProviderDetails: IdentityProviderDetails?

  • 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.

    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 for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.

    Declaration

    Swift

    public let loggingRole: 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

    Declaration

    Swift

    public let protocols: [Protocol]?

  • Specifies the name of the security policy that is attached to the server.

    Declaration

    Swift

    public let securityPolicyName: String?

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

    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 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.

    Declaration

    Swift

    public let tags: [Tag]?

  • 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, certificate: String? = nil, endpointDetails: EndpointDetails? = nil, endpointType: EndpointType? = nil, hostKeyFingerprint: String? = nil, identityProviderDetails: IdentityProviderDetails? = nil, identityProviderType: IdentityProviderType? = nil, loggingRole: String? = nil, protocols: [Protocol]? = nil, securityPolicyName: String? = nil, serverId: String? = nil, state: State? = nil, tags: [Tag]? = nil, userCount: Int? = nil)