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

Class UpdateAgreementRequest

    • Method Detail

      • agreementId

        public final String agreementId()

        A unique identifier for the agreement. This identifier is returned when you create an agreement.

        Returns:
        A unique identifier for the agreement. This identifier is returned when you create an agreement.

      • serverId

        public final String serverId()

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

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

      • description

        public final String description()

        To replace the existing description, provide a short description for the agreement.

        Returns:
        To replace the existing description, provide a short description for the agreement.

      • status

        public final AgreementStatusType status()

        You can update the status for the agreement, either activating an inactive agreement or the reverse.

        If the service returns an enum value that is not available in the current SDK version, status will return AgreementStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        You can update the status for the agreement, either activating an inactive agreement or the reverse.
        See Also:
        AgreementStatusType

      • statusAsString

        public final String statusAsString()

        You can update the status for the agreement, either activating an inactive agreement or the reverse.

        If the service returns an enum value that is not available in the current SDK version, status will return AgreementStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        You can update the status for the agreement, either activating an inactive agreement or the reverse.
        See Also:
        AgreementStatusType

      • localProfileId

        public final String localProfileId()

        A unique identifier for the AS2 local profile.

        To change the local profile identifier, provide a new value here.

        Returns:
        A unique identifier for the AS2 local profile.

        To change the local profile identifier, provide a new value here.

      • partnerProfileId

        public final String partnerProfileId()

        A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here.

        Returns:
        A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here.

      • baseDirectory

        public final String baseDirectory()

        To change the landing directory (folder) for files that are transferred, provide the bucket folder that you want to use; for example, /amzn-s3-demo-bucket/home/mydirectory .

        Returns:
        To change the landing directory (folder) for files that are transferred, provide the bucket folder that you want to use; for example, /amzn-s3-demo-bucket/home/mydirectory .

      • accessRole

        public final 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.

        Returns:
        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.

      • preserveFilename

        public final 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.

        If the service returns an enum value that is not available in the current SDK version, preserveFilename will return PreserveFilenameType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from preserveFilenameAsString().

        Returns:
        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.

        See Also:
        PreserveFilenameType

      • preserveFilenameAsString

        public final String preserveFilenameAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, preserveFilename will return PreserveFilenameType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from preserveFilenameAsString().

        Returns:
        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.

        See Also:
        PreserveFilenameType

      • enforceMessageSigning

        public final 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.

        If the service returns an enum value that is not available in the current SDK version, enforceMessageSigning will return EnforceMessageSigningType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from enforceMessageSigningAsString().

        Returns:
        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.

        See Also:
        EnforceMessageSigningType

      • enforceMessageSigningAsString

        public final String enforceMessageSigningAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, enforceMessageSigning will return EnforceMessageSigningType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from enforceMessageSigningAsString().

        Returns:
        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.

        See Also:
        EnforceMessageSigningType

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object