--- title: Getting Started with Datadog description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog --- # aws_transfer_server{% #aws_transfer_server %} ## `account_id`{% #account_id %} **Type**: `STRING` ## `arn`{% #arn %} **Type**: `STRING`**Provider name**: `Arn`**Description**: Specifies the unique Amazon Resource Name (ARN) of the server. ## `as2_service_managed_egress_ip_addresses`{% #as2_service_managed_egress_ip_addresses %} **Type**: `UNORDERED_LIST_STRING`**Provider name**: `As2ServiceManagedEgressIpAddresses`**Description**: The list of egress IP addresses of this server. These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs. These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well. ## `certificate`{% #certificate %} **Type**: `STRING`**Provider name**: `Certificate`**Description**: Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when `Protocols` is set to `FTPS`. ## `domain`{% #domain %} **Type**: `STRING`**Provider name**: `Domain`**Description**: Specifies the domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3. ## `endpoint_details`{% #endpoint_details %} **Type**: `STRUCT`**Provider name**: `EndpointDetails`**Description**: The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint. - `address_allocation_ids`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `AddressAllocationIds`**Description**: A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint. An address allocation ID corresponds to the allocation ID of an Elastic IP address. This value can be retrieved from the `allocationId` field from the Amazon EC2 [Address](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Address.html) data type. One way to retrieve this value is by calling the EC2 [DescribeAddresses](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAddresses.html) API. This parameter is optional. Set this parameter if you want to make your VPC endpoint public-facing. For details, see [Create an internet-facing endpoint for your server](https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#create-internet-facing-endpoint).This property can only be set as follows: - `EndpointType` must be set to `VPC` - The Transfer Family server must be offline. - You cannot set this parameter for Transfer Family servers that use the FTP protocol. - The server must already have `SubnetIds` populated (`SubnetIds` and `AddressAllocationIds` cannot be updated simultaneously). - `AddressAllocationIds` can't contain duplicates, and must be equal in length to `SubnetIds`. For example, if you have three subnet IDs, you must also specify three address allocation IDs. - Call the `UpdateServer` API to set or change this parameter. - `security_group_ids`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `SecurityGroupIds`**Description**: A list of security groups IDs that are available to attach to your server's endpoint.This property can only be set when `EndpointType` is set to `VPC`. You can edit the `SecurityGroupIds` property in the [UpdateServer](https://docs.aws.amazon.com/transfer/latest/userguide/API_UpdateServer.html) API only if you are changing the `EndpointType` from `PUBLIC` or `VPC_ENDPOINT` to `VPC`. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 [ModifyVpcEndpoint](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyVpcEndpoint.html) API. - `subnet_ids`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `SubnetIds`**Description**: A list of subnet IDs that are required to host your server endpoint in your VPC.This property can only be set when `EndpointType` is set to `VPC`. - `vpc_endpoint_id`**Type**: `STRING`**Provider name**: `VpcEndpointId`**Description**: The identifier of the VPC endpoint.This property can only be set when `EndpointType` is set to `VPC_ENDPOINT`. For more information, see [https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint](https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint). - `vpc_id`**Type**: `STRING`**Provider name**: `VpcId`**Description**: The VPC identifier of the VPC in which a server's endpoint will be hosted.This property can only be set when `EndpointType` is set to `VPC`. ## `endpoint_type`{% #endpoint_type %} **Type**: `STRING`**Provider name**: `EndpointType`**Description**: 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. ## `host_key_fingerprint`{% #host_key_fingerprint %} **Type**: `STRING`**Provider name**: `HostKeyFingerprint`**Description**: 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`{% #identity_provider_details %} **Type**: `STRUCT`**Provider name**: `IdentityProviderDetails`**Description**: 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`. - `directory_id`**Type**: `STRING`**Provider name**: `DirectoryId`**Description**: The identifier of the Directory Service directory that you want to use as your identity provider. - `function`**Type**: `STRING`**Provider name**: `Function`**Description**: The ARN for a Lambda function to use for the Identity provider. - `invocation_role`**Type**: `STRING`**Provider name**: `InvocationRole`**Description**: This parameter is only applicable if your `IdentityProviderType` is `API_GATEWAY`. Provides the type of `InvocationRole` used to authenticate the user account. - `sftp_authentication_methods`**Type**: `STRING`**Provider name**: `SftpAuthenticationMethods`**Description**: For SFTP-enabled servers, and for custom identity providers only, you can specify whether to authenticate using a password, SSH key pair, or both. - `PASSWORD` - users must provide their password to connect. - `PUBLIC_KEY` - users must provide their private key to connect. - `PUBLIC_KEY_OR_PASSWORD` - users can authenticate with either their password or their key. This is the default value. - `PUBLIC_KEY_AND_PASSWORD` - users must provide both their private key and their password to connect. The server checks the key first, and then if the key is valid, the system prompts for a password. If the private key provided does not match the public key that is stored, authentication fails. - `url`**Type**: `STRING`**Provider name**: `Url`**Description**: Provides the location of the service endpoint used to authenticate users. ## `identity_provider_type`{% #identity_provider_type %} **Type**: `STRING`**Provider name**: `IdentityProviderType`**Description**: 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`{% #logging_role %} **Type**: `STRING`**Provider name**: `LoggingRole`**Description**: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs. ## `post_authentication_login_banner`{% #post_authentication_login_banner %} **Type**: `STRING`**Provider name**: `PostAuthenticationLoginBanner`**Description**: Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.The SFTP protocol does not support post-authentication display banners. ## `pre_authentication_login_banner`{% #pre_authentication_login_banner %} **Type**: `STRING`**Provider name**: `PreAuthenticationLoginBanner`**Description**: Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system: `This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.` ## `protocol_details`{% #protocol_details %} **Type**: `STRUCT`**Provider name**: `ProtocolDetails`**Description**: The protocol settings that are configured for your server. - To indicate passive mode (for FTP and FTPS protocols), use the `PassiveIp` parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. - To ignore the error that is generated when the client attempts to use the `SETSTAT` command on a file that you are uploading to an Amazon S3 bucket, use the `SetStatOption` parameter. To have the Transfer Family server ignore the `SETSTAT` command and upload files without needing to make any changes to your SFTP client, set the value to `ENABLE_NO_OP`. If you set the `SetStatOption` parameter to `ENABLE_NO_OP`, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a `SETSTAT` call. - To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the `TlsSessionResumptionMode` parameter. - `As2Transports` indicates the transport method for the AS2 messages. Currently, only HTTP is supported. - `as2_transports`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `As2Transports`**Description**: Indicates the transport method for the AS2 messages. Currently, only HTTP is supported. - `passive_ip`**Type**: `STRING`**Provider name**: `PassiveIp`**Description**: Indicates passive mode, for FTP and FTPS protocols. Enter a single IPv4 address, such as the public IP address of a firewall, router, or load balancer. For example: `aws transfer update-server –protocol-details PassiveIp=0.0.0.0` Replace `0.0.0.0` in the example above with the actual IP address you want to use.If you change the `PassiveIp` value, you must stop and then restart your Transfer Family server for the change to take effect. For details on using passive mode (PASV) in a NAT environment, see [Configuring your FTPS server behind a firewall or NAT with Transfer Family](http://aws.amazon.com/blogs/storage/configuring-your-ftps-server-behind-a-firewall-or-nat-with-aws-transfer-family/).Special values The `AUTO` and `0.0.0.0` are special values for the `PassiveIp` parameter. The value `PassiveIp=AUTO` is assigned by default to FTP and FTPS type servers. In this case, the server automatically responds with one of the endpoint IPs within the PASV response. `PassiveIp=0.0.0.0` has a more unique application for its usage. For example, if you have a High Availability (HA) Network Load Balancer (NLB) environment, where you have 3 subnets, you can only specify a single IP address using the `PassiveIp` parameter. This reduces the effectiveness of having High Availability. In this case, you can specify `PassiveIp=0.0.0.0`. This tells the client to use the same IP address as the Control connection and utilize all AZs for their connections. Note, however, that not all FTP clients support the `PassiveIp=0.0.0.0` response. FileZilla and WinSCP do support it. If you are using other clients, check to see if your client supports the `PassiveIp=0.0.0.0` response. - `set_stat_option`**Type**: `STRING`**Provider name**: `SetStatOption`**Description**: Use the `SetStatOption` to ignore the error that is generated when the client attempts to use `SETSTAT` on a file you are uploading to an S3 bucket. Some SFTP file transfer clients can attempt to change the attributes of remote files, including timestamp and permissions, using commands, such as `SETSTAT` when uploading the file. However, these commands are not compatible with object storage systems, such as Amazon S3. Due to this incompatibility, file uploads from these clients can result in errors even when the file is otherwise successfully uploaded. Set the value to `ENABLE_NO_OP` to have the Transfer Family server ignore the `SETSTAT` command, and upload files without needing to make any changes to your SFTP client. While the `SetStatOption` `ENABLE_NO_OP` setting ignores the error, it does generate a log entry in Amazon CloudWatch Logs, so you can determine when the client is making a `SETSTAT` call.If you want to preserve the original timestamp for your file, and modify other file attributes using `SETSTAT`, you can use Amazon EFS as backend storage with Transfer Family. - `tls_session_resumption_mode`**Type**: `STRING`**Provider name**: `TlsSessionResumptionMode`**Description**: A property used with Transfer Family servers that use the FTPS protocol. TLS Session Resumption provides a mechanism to resume or share a negotiated secret key between the control and data connection for an FTPS session. `TlsSessionResumptionMode` determines whether or not the server resumes recent, negotiated sessions through a unique session ID. This property is available during `CreateServer` and `UpdateServer` calls. If a `TlsSessionResumptionMode` value is not specified during `CreateServer`, it is set to `ENFORCED` by default. - `DISABLED`: the server does not process TLS session resumption client requests and creates a new TLS session for each request. - `ENABLED`: the server processes and accepts clients that are performing TLS session resumption. The server doesn't reject client data connections that do not perform the TLS session resumption client processing. - `ENFORCED`: the server processes and accepts clients that are performing TLS session resumption. The server rejects client data connections that do not perform the TLS session resumption client processing. Before you set the value to `ENFORCED`, test your clients.Not all FTPS clients perform TLS session resumption. So, if you choose to enforce TLS session resumption, you prevent any connections from FTPS clients that don't perform the protocol negotiation. To determine whether or not you can use the `ENFORCED` value, you need to test your clients. ## `protocols`{% #protocols %} **Type**: `UNORDERED_LIST_STRING`**Provider name**: `Protocols`**Description**: 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 - `AS2` (Applicability Statement 2): used for transporting structured business-to-business data - If you select `FTPS`, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS. - If `Protocol` includes either `FTP` or `FTPS`, then the `EndpointType` must be `VPC` and the `IdentityProviderType` must be either `AWS_DIRECTORY_SERVICE`, `AWS_LAMBDA`, or `API_GATEWAY`. - If `Protocol` includes `FTP`, then `AddressAllocationIds` cannot be associated. - If `Protocol` is set only to `SFTP`, the `EndpointType` can be set to `PUBLIC` and the `IdentityProviderType` can be set any of the supported identity types: `SERVICE_MANAGED`, `AWS_DIRECTORY_SERVICE`, `AWS_LAMBDA`, or `API_GATEWAY`. - If `Protocol` includes `AS2`, then the `EndpointType` must be `VPC`, and domain must be Amazon S3. ## `s3_storage_options`{% #s3_storage_options %} **Type**: `STRUCT`**Provider name**: `S3StorageOptions`**Description**: Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default. By default, home directory mappings have a `TYPE` of `DIRECTORY`. If you enable this option, you would then need to explicitly set the `HomeDirectoryMapEntry` `Type` to `FILE` if you want a mapping to have a file target. - `directory_listing_optimization`**Type**: `STRING`**Provider name**: `DirectoryListingOptimization`**Description**: Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default. By default, home directory mappings have a `TYPE` of `DIRECTORY`. If you enable this option, you would then need to explicitly set the `HomeDirectoryMapEntry` `Type` to `FILE` if you want a mapping to have a file target. ## `security_policy_name`{% #security_policy_name %} **Type**: `STRING`**Provider name**: `SecurityPolicyName`**Description**: Specifies the name of the security policy for the server. ## `server_id`{% #server_id %} **Type**: `STRING`**Provider name**: `ServerId`**Description**: Specifies the unique system-assigned identifier for a server that you instantiate. ## `state`{% #state %} **Type**: `STRING`**Provider name**: `State`**Description**: The condition of 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. ## `structured_log_destinations`{% #structured_log_destinations %} **Type**: `UNORDERED_LIST_STRING`**Provider name**: `StructuredLogDestinations`**Description**: Specifies the log groups to which your server logs are sent. To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows: `arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:` For example, `arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:` If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an `update-server` call. For example: `update-server –server-id s-1234567890abcdef0 –structured-log-destinations` ## `tags`{% #tags %} **Type**: `UNORDERED_LIST_STRING` ## `user_count`{% #user_count %} **Type**: `INT32`**Provider name**: `UserCount`**Description**: Specifies the number of users that are assigned to a server you specified with the `ServerId`. ## `workflow_details`{% #workflow_details %} **Type**: `STRUCT`**Provider name**: `WorkflowDetails`**Description**: Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow. In addition to a workflow to execute when a file is uploaded completely, `WorkflowDetails` can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded. - `on_partial_upload`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `OnPartialUpload`**Description**: A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload. A partial upload occurs when a file is open when the session disconnects.`OnPartialUpload` can contain a maximum of one `WorkflowDetail` object. - `execution_role`**Type**: `STRING`**Provider name**: `ExecutionRole`**Description**: Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can assume, so that all workflow steps can operate on the required resources - `workflow_id`**Type**: `STRING`**Provider name**: `WorkflowId`**Description**: A unique identifier for the workflow. - `on_upload`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `OnUpload`**Description**: A trigger that starts a workflow: the workflow begins to execute after a file is uploaded. To remove an associated workflow from a server, you can provide an empty `OnUpload` object, as in the following example. `aws transfer update-server –server-id s-01234567890abcdef –workflow-details '{"OnUpload":[]}'``OnUpload` can contain a maximum of one `WorkflowDetail` object. - `execution_role`**Type**: `STRING`**Provider name**: `ExecutionRole`**Description**: Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can assume, so that all workflow steps can operate on the required resources - `workflow_id`**Type**: `STRING`**Provider name**: `WorkflowId`**Description**: A unique identifier for the workflow.