servers

Describes the properties of a file transfer protocol-enabled server that was specified.

Overview

Name	servers
Type	Resource
Description	Describes the properties of a file transfer protocol-enabled server that was specified.
Id	aws.transfer.servers

Fields

Name	Datatype	Description
arn	string
certificate	object	Resource Type definition for AWS::Transfer::Certificate
protocol_details	object	The protocol settings that are configured for your server.
domain	string
endpoint_details	object	The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. To control incoming internet traffic, invoke the UpdateServer API and attach an Elastic IP address to your server's endpoint. After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC. For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
endpoint_type	string
host_key_fingerprint	string
identity_provider_details	object	Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled server's users. A server can have only one method of authentication.
identity_provider_type	string	The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service. Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by 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 Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter. Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter for the IdentityProviderDetails data type.
logging_role	string
post_authentication_login_banner	string
pre_authentication_login_banner	string
protocols	array
s3_storage_options	object
security_policy_name	string
server_id	string
state	string	Describes the condition of a file transfer protocol-enabled server with respect to its ability to perform file operations. There are six possible states: OFFLINE, ONLINE, STARTING, STOPPING, START_FAILED, and STOP_FAILED. OFFLINE indicates that the server exists, but that it is not available for file operations. ONLINE indicates that the server is available to perform file operations. STARTING indicates that the server's was instantiated, but the server is not yet available to perform file operations. Under normal conditions, it can take a couple of minutes for the server to be completely operational. Both START_FAILED and STOP_FAILED are error conditions.
tags	array
user_count	integer
workflow_details	object	Container for the WorkflowDetail data type. It is used by actions that trigger a workflow to begin execution.
structured_log_destinations	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
describe_server	SELECT	data__ServerId, region
list_servers	SELECT	region
create_server	INSERT	region
delete_server	DELETE	data__ServerId, region
update_server	UPDATE	data__ServerId, region
start_server	EXEC	data__ServerId, region
stop_server	EXEC	region