AWS Transfer Family

2020/10/15 - AWS Transfer Family - 3 updated api methods

Changes  Add support to associate VPC Security Groups at server creation.

CreateServer (updated) Link ¶
Changes (request)
{'EndpointDetails': {'SecurityGroupIds': ['string']}}

Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.

See also: AWS API Documentation

Request Syntax

client.create_server(
    Certificate='string',
    EndpointDetails={
        'AddressAllocationIds': [
            'string',
        ],
        'SubnetIds': [
            'string',
        ],
        'VpcEndpointId': 'string',
        'VpcId': 'string',
        'SecurityGroupIds': [
            'string',
        ]
    },
    EndpointType='PUBLIC'|'VPC'|'VPC_ENDPOINT',
    HostKey='string',
    IdentityProviderDetails={
        'Url': 'string',
        'InvocationRole': 'string'
    },
    IdentityProviderType='SERVICE_MANAGED'|'API_GATEWAY',
    LoggingRole='string',
    Protocols=[
        'SFTP'|'FTP'|'FTPS',
    ],
    SecurityPolicyName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type Certificate

string

param Certificate

The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS .

To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide .

To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide .

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide .

Certificates with the following cryptographic algorithms and key sizes are supported:

  • 2048-bit RSA (RSA_2048)

  • 4096-bit RSA (RSA_4096)

  • Elliptic Prime Curve 256 bit (EC_prime256v1)

  • Elliptic Prime Curve 384 bit (EC_secp384r1)

  • Elliptic Prime Curve 521 bit (EC_secp521r1)

Note

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

type EndpointDetails

dict

param EndpointDetails

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 IPs and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.

  • AddressAllocationIds (list) --

    A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.

    Note

    This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.

    • (string) --

  • SubnetIds (list) --

    A list of subnet IDs that are required to host your server endpoint in your VPC.

    Note

    This property can only be set when EndpointType is set to VPC .

    • (string) --

  • VpcEndpointId (string) --

    The ID of the VPC endpoint.

    Note

    This property can only be set when EndpointType is set to VPC_ENDPOINT .

  • VpcId (string) --

    The VPC ID of the VPC in which a server's endpoint will be hosted.

    Note

    This property can only be set when EndpointType is set to VPC .

  • SecurityGroupIds (list) --

    A list of security groups IDs that are available to attach to your server's endpoint.

    Note

    This property can only be set when EndpointType is set to VPC .

    You can only edit the SecurityGroupIds property in the UpdateServer API and only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC .

    • (string) --

type EndpointType

string

param EndpointType

The type of VPC endpoint that you want your server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.

Note

It is recommended that you use VPC as the EndpointType . With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT .

type HostKey

string

param HostKey

The RSA private key as generated by the ssh-keygen -N "" -m PEM -f my-new-server-key command.

Warning

If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide .

type IdentityProviderDetails

dict

param IdentityProviderDetails

Required when IdentityProviderType is set to API_GATEWAY . Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED .

  • Url (string) --

    Provides the location of the service endpoint used to authenticate users.

  • InvocationRole (string) --

    Provides the type of InvocationRole used to authenticate the user account.

type IdentityProviderType

string

param IdentityProviderType

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 AWS Transfer Family service. 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.

type LoggingRole

string

param LoggingRole

Allows the service to write your users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.

type Protocols

list

param 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

Note

If you select FTPS , you must choose a certificate stored in AWS Certificate Manager (ACM) which will be 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 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 to SERVICE_MANAGED .

  • (string) --

type SecurityPolicyName

string

param SecurityPolicyName

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

type Tags

list

param Tags

Key-value pairs that can be used to group and search for servers.

  • (dict) --

    Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.

    • Key (string) -- [REQUIRED]

      The name assigned to the tag that you create.

    • Value (string) -- [REQUIRED]

      Contains one or more values that you assigned to the key name you create.

rtype

dict

returns

Response Syntax

{
    'ServerId': 'string'
}

Response Structure

  • (dict) --

    • ServerId (string) --

      The service-assigned ID of the server that is created.

DescribeServer (updated) Link ¶
Changes (response)
{'Server': {'EndpointDetails': {'SecurityGroupIds': ['string']}}}

Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

The response contains a description of a server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails .

See also: AWS API Documentation

Request Syntax

client.describe_server(
    ServerId='string'
)
type ServerId

string

param ServerId

[REQUIRED]

A system-assigned unique identifier for a server.

rtype

dict

returns

Response Syntax

{
    'Server': {
        'Arn': 'string',
        'Certificate': 'string',
        'EndpointDetails': {
            'AddressAllocationIds': [
                'string',
            ],
            'SubnetIds': [
                'string',
            ],
            'VpcEndpointId': 'string',
            'VpcId': 'string',
            'SecurityGroupIds': [
                'string',
            ]
        },
        'EndpointType': 'PUBLIC'|'VPC'|'VPC_ENDPOINT',
        'HostKeyFingerprint': 'string',
        'IdentityProviderDetails': {
            'Url': 'string',
            'InvocationRole': 'string'
        },
        'IdentityProviderType': 'SERVICE_MANAGED'|'API_GATEWAY',
        'LoggingRole': 'string',
        'Protocols': [
            'SFTP'|'FTP'|'FTPS',
        ],
        'SecurityPolicyName': 'string',
        'ServerId': 'string',
        'State': 'OFFLINE'|'ONLINE'|'STARTING'|'STOPPING'|'START_FAILED'|'STOP_FAILED',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'UserCount': 123
    }
}

Response Structure

  • (dict) --

    • Server (dict) --

      An array containing the properties of a server with the ServerID you specified.

      • Arn (string) --

        Specifies the unique Amazon Resource Name (ARN) of the server.

      • Certificate (string) --

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

      • EndpointDetails (dict) --

        Specifies the virtual private cloud (VPC) endpoint settings that you configured for your server.

        • AddressAllocationIds (list) --

          A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.

          Note

          This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.

          • (string) --

        • SubnetIds (list) --

          A list of subnet IDs that are required to host your server endpoint in your VPC.

          Note

          This property can only be set when EndpointType is set to VPC .

          • (string) --

        • VpcEndpointId (string) --

          The ID of the VPC endpoint.

          Note

          This property can only be set when EndpointType is set to VPC_ENDPOINT .

        • VpcId (string) --

          The VPC ID of the VPC in which a server's endpoint will be hosted.

          Note

          This property can only be set when EndpointType is set to VPC .

        • SecurityGroupIds (list) --

          A list of security groups IDs that are available to attach to your server's endpoint.

          Note

          This property can only be set when EndpointType is set to VPC .

          You can only edit the SecurityGroupIds property in the UpdateServer API and only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC .

          • (string) --

      • EndpointType (string) --

        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.

      • HostKeyFingerprint (string) --

        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.

      • IdentityProviderDetails (dict) --

        Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a server is SERVICE_MANAGED .

        • Url (string) --

          Provides the location of the service endpoint used to authenticate users.

        • InvocationRole (string) --

          Provides the type of InvocationRole used to authenticate the user account.

      • IdentityProviderType (string) --

        Specifies the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this 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.

      • LoggingRole (string) --

        Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.

      • Protocols (list) --

        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

        • (string) --

      • SecurityPolicyName (string) --

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

      • ServerId (string) --

        Specifies the unique system-assigned identifier for a server that you instantiate.

      • State (string) --

        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.

      • Tags (list) --

        Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.

        • (dict) --

          Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.

          • Key (string) --

            The name assigned to the tag that you create.

          • Value (string) --

            Contains one or more values that you assigned to the key name you create.

      • UserCount (integer) --

        Specifies the number of users that are assigned to a server you specified with the ServerId .

UpdateServer (updated) Link ¶
Changes (request)
{'EndpointDetails': {'SecurityGroupIds': ['string']}}

Updates the file transfer protocol-enabled server's properties after that server has been created.

The UpdateServer call returns the ServerId of the server you updated.

See also: AWS API Documentation

Request Syntax

client.update_server(
    Certificate='string',
    EndpointDetails={
        'AddressAllocationIds': [
            'string',
        ],
        'SubnetIds': [
            'string',
        ],
        'VpcEndpointId': 'string',
        'VpcId': 'string',
        'SecurityGroupIds': [
            'string',
        ]
    },
    EndpointType='PUBLIC'|'VPC'|'VPC_ENDPOINT',
    HostKey='string',
    IdentityProviderDetails={
        'Url': 'string',
        'InvocationRole': 'string'
    },
    LoggingRole='string',
    Protocols=[
        'SFTP'|'FTP'|'FTPS',
    ],
    SecurityPolicyName='string',
    ServerId='string'
)
type Certificate

string

param Certificate

The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS .

To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide .

To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide .

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide .

Certificates with the following cryptographic algorithms and key sizes are supported:

  • 2048-bit RSA (RSA_2048)

  • 4096-bit RSA (RSA_4096)

  • Elliptic Prime Curve 256 bit (EC_prime256v1)

  • Elliptic Prime Curve 384 bit (EC_secp384r1)

  • Elliptic Prime Curve 521 bit (EC_secp521r1)

Note

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

type EndpointDetails

dict

param EndpointDetails

The virtual private cloud (VPC) endpoint settings that are configured for your server. With a VPC endpoint, you can restrict access to your server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.

  • AddressAllocationIds (list) --

    A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.

    Note

    This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.

    • (string) --

  • SubnetIds (list) --

    A list of subnet IDs that are required to host your server endpoint in your VPC.

    Note

    This property can only be set when EndpointType is set to VPC .

    • (string) --

  • VpcEndpointId (string) --

    The ID of the VPC endpoint.

    Note

    This property can only be set when EndpointType is set to VPC_ENDPOINT .

  • VpcId (string) --

    The VPC ID of the VPC in which a server's endpoint will be hosted.

    Note

    This property can only be set when EndpointType is set to VPC .

  • SecurityGroupIds (list) --

    A list of security groups IDs that are available to attach to your server's endpoint.

    Note

    This property can only be set when EndpointType is set to VPC .

    You can only edit the SecurityGroupIds property in the UpdateServer API and only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC .

    • (string) --

type EndpointType

string

param EndpointType

The type of endpoint that you want your server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.

Note

It is recommended that you use VPC as the EndpointType . With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT .

type HostKey

string

param HostKey

The RSA private key as generated by ssh-keygen -N "" -m PEM -f my-new-server-key .

Warning

If you aren't planning to migrate existing users from an existing server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide .

type IdentityProviderDetails

dict

param IdentityProviderDetails

An array containing all of the information required to call a customer's authentication API method.

  • Url (string) --

    Provides the location of the service endpoint used to authenticate users.

  • InvocationRole (string) --

    Provides the type of InvocationRole used to authenticate the user account.

type LoggingRole

string

param LoggingRole

Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

type Protocols

list

param 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:

  • Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH

  • File Transfer Protocol Secure (FTPS): File transfer with TLS encryption

  • File Transfer Protocol (FTP): Unencrypted file transfer

Note

If you select FTPS , you must choose a certificate stored in AWS Certificate Manager (ACM) which will be 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 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 to SERVICE_MANAGED .

  • (string) --

type SecurityPolicyName

string

param SecurityPolicyName

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

type ServerId

string

param ServerId

[REQUIRED]

A system-assigned unique identifier for a server instance that the user account is assigned to.

rtype

dict

returns

Response Syntax

{
    'ServerId': 'string'
}

Response Structure

  • (dict) --

    • ServerId (string) --

      A system-assigned unique identifier for a server that the user account is assigned to.