Package software.amazon.awssdk.services.transfer.model

Interface ListedServer.Builder

    • Method Detail

      • arn

        ListedServer.Builder arn​(String arn)

        Specifies the unique Amazon Resource Name (ARN) for a server to be listed.

        Parameters:
        arn - Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • domain

        ListedServer.Builder domain​(String domain)

        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.

        Parameters:
        domain - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Domain, Domain

      • domain

        ListedServer.Builder domain​(Domain domain)

        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.

        Parameters:
        domain - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Domain, Domain

      • identityProviderType

        ListedServer.Builder identityProviderType​(String identityProviderType)

        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.

        Parameters:
        identityProviderType - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        IdentityProviderType, IdentityProviderType

      • identityProviderType

        ListedServer.Builder identityProviderType​(IdentityProviderType identityProviderType)

        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.

        Parameters:
        identityProviderType - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        IdentityProviderType, IdentityProviderType

      • endpointType

        ListedServer.Builder endpointType​(String endpointType)

        Specifies the type of VPC 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.

        Parameters:
        endpointType - Specifies the type of VPC 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EndpointType, EndpointType

      • endpointType

        ListedServer.Builder endpointType​(EndpointType endpointType)

        Specifies the type of VPC 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.

        Parameters:
        endpointType - Specifies the type of VPC 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EndpointType, EndpointType

      • loggingRole

        ListedServer.Builder loggingRole​(String loggingRole)

        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.

        Parameters:
        loggingRole - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serverId

        ListedServer.Builder serverId​(String serverId)

        Specifies the unique system assigned identifier for the servers that were listed.

        Parameters:
        serverId - Specifies the unique system assigned identifier for the servers that were listed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • state

        ListedServer.Builder state​(String state)

        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.

        Parameters:
        state - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        State, State

      • state

        ListedServer.Builder state​(State state)

        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.

        Parameters:
        state - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        State, State

      • userCount

        ListedServer.Builder userCount​(Integer userCount)

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

        Parameters:
        userCount - Specifies the number of users that are assigned to a server you specified with the ServerId.
        Returns:
        Returns a reference to this object so that method calls can be chained together.