class Aws::Transfer::Types::DescribedServer
Describes the properties of a file transfer protocol-enabled server that was specified.
@!attribute [rw] arn
Specifies the unique Amazon Resource Name (ARN) of the server. @return [String]
@!attribute [rw] certificate
Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when `Protocols` is set to `FTPS`. @return [String]
@!attribute [rw] protocol_details
The protocol settings that are configured for your server. Use the `PassiveIp` parameter to indicate passive mode. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. @return [Types::ProtocolDetails]
@!attribute [rw] domain
Specifies the domain of the storage system that is used for file transfers. @return [String]
@!attribute [rw] endpoint_details
The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint. @return [Types::EndpointDetails]
@!attribute [rw] endpoint_type
Defines the type of 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. @return [String]
@!attribute [rw] host_key_fingerprint
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. @return [String]
@!attribute [rw] identity_provider_details
Specifies information to call a customer-supplied authentication API. This field is not populated when the `IdentityProviderType` of a server is `AWS_DIRECTORY_SERVICE` or `SERVICE_MANAGED`. @return [Types::IdentityProviderDetails]
@!attribute [rw] identity_provider_type
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. @return [String]
@!attribute [rw] logging_role
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. @return [String]
@!attribute [rw] protocols
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 @return [Array<String>]
@!attribute [rw] security_policy_name
Specifies the name of the security policy that is attached to the server. @return [String]
@!attribute [rw] server_id
Specifies the unique system-assigned identifier for a server that you instantiate. @return [String]
@!attribute [rw] state
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. @return [String]
@!attribute [rw] tags
Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described. @return [Array<Types::Tag>]
@!attribute [rw] user_count
Specifies the number of users that are assigned to a server you specified with the `ServerId`. @return [Integer]
@!attribute [rw] workflow_details
Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow. @return [Types::WorkflowDetails]
@see docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedServer AWS API Documentation
Constants
- SENSITIVE