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

Interface CreateAgreementRequest.Builder

    • Method Detail

      • description

        CreateAgreementRequest.Builder description​(String description)

        A name or short description to identify the agreement.

        Parameters:
        description - A name or short description to identify the agreement.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serverId

        CreateAgreementRequest.Builder serverId​(String serverId)

        A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.

        Parameters:
        serverId - A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • localProfileId

        CreateAgreementRequest.Builder localProfileId​(String localProfileId)

        A unique identifier for the AS2 local profile.

        Parameters:
        localProfileId - A unique identifier for the AS2 local profile.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • partnerProfileId

        CreateAgreementRequest.Builder partnerProfileId​(String partnerProfileId)

        A unique identifier for the partner profile used in the agreement.

        Parameters:
        partnerProfileId - A unique identifier for the partner profile used in the agreement.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • baseDirectory

        CreateAgreementRequest.Builder baseDirectory​(String baseDirectory)

        The landing directory (folder) for files transferred by using the AS2 protocol.

        A BaseDirectory example is /amzn-s3-demo-bucket/home/mydirectory.

        Parameters:
        baseDirectory - The landing directory (folder) for files transferred by using the AS2 protocol.

        A BaseDirectory example is /amzn-s3-demo-bucket/home/mydirectory.

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

      • accessRole

        CreateAgreementRequest.Builder accessRole​(String accessRole)

        Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

        For AS2 connectors

        With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

        If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

        For SFTP connectors

        Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

        Parameters:
        accessRole - Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

        For AS2 connectors

        With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/ ) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

        If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

        For SFTP connectors

        Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

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

      • status

        CreateAgreementRequest.Builder status​(String status)

        The status of the agreement. The agreement can be either ACTIVE or INACTIVE.

        Parameters:
        status - The status of the agreement. The agreement can be either ACTIVE or INACTIVE.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AgreementStatusType, AgreementStatusType

      • tags

        CreateAgreementRequest.Builder tags​(Collection<Tag> tags)

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

        Parameters:
        tags - Key-value pairs that can be used to group and search for agreements.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateAgreementRequest.Builder tags​(Tag... tags)

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

        Parameters:
        tags - Key-value pairs that can be used to group and search for agreements.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateAgreementRequest.Builder tags​(Consumer<Tag.Builder>... tags)

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

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • preserveFilename

        CreateAgreementRequest.Builder preserveFilename​(String preserveFilename)

        Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.

        • ENABLED: the filename provided by your trading parter is preserved when the file is saved.

        • DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as described in File names and locations.

        Parameters:
        preserveFilename - Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.

        • ENABLED: the filename provided by your trading parter is preserved when the file is saved.

        • DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as described in File names and locations.

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

      • preserveFilename

        CreateAgreementRequest.Builder preserveFilename​(PreserveFilenameType preserveFilename)

        Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.

        • ENABLED: the filename provided by your trading parter is preserved when the file is saved.

        • DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as described in File names and locations.

        Parameters:
        preserveFilename - Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.

        • ENABLED: the filename provided by your trading parter is preserved when the file is saved.

        • DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as described in File names and locations.

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

      • enforceMessageSigning

        CreateAgreementRequest.Builder enforceMessageSigning​(String enforceMessageSigning)

        Determines whether or not unsigned messages from your trading partners will be accepted.

        • ENABLED: Transfer Family rejects unsigned messages from your trading partner.

        • DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.

        Parameters:
        enforceMessageSigning - Determines whether or not unsigned messages from your trading partners will be accepted.

        • ENABLED: Transfer Family rejects unsigned messages from your trading partner.

        • DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.

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

      • enforceMessageSigning

        CreateAgreementRequest.Builder enforceMessageSigning​(EnforceMessageSigningType enforceMessageSigning)

        Determines whether or not unsigned messages from your trading partners will be accepted.

        • ENABLED: Transfer Family rejects unsigned messages from your trading partner.

        • DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.

        Parameters:
        enforceMessageSigning - Determines whether or not unsigned messages from your trading partners will be accepted.

        • ENABLED: Transfer Family rejects unsigned messages from your trading partner.

        • DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.

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