Interface UpdateAgreementRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateAgreementRequest.Builder,UpdateAgreementRequest>, SdkBuilder<UpdateAgreementRequest.Builder,UpdateAgreementRequest>, SdkPojo, SdkRequest.Builder, TransferRequest.Builder
Enclosing class:
UpdateAgreementRequest
@Mutable @NotThreadSafe public static interface UpdateAgreementRequest.Builder extends TransferRequest.Builder, SdkPojo, CopyableBuilder<UpdateAgreementRequest.Builder,UpdateAgreementRequest>

  • Method Details

    • agreementId

      UpdateAgreementRequest.Builder agreementId(String agreementId)

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

      Parameters:
      agreementId - A unique identifier for the agreement. This identifier is returned when you create an agreement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serverId

      UpdateAgreementRequest.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.

    • description

      UpdateAgreementRequest.Builder description(String description)

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

      Parameters:
      description - To replace the existing description, provide a short description for the agreement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      UpdateAgreementRequest.Builder status(String status)

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

      Parameters:
      status - You can update the status for the agreement, either activating an inactive agreement or the reverse.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      UpdateAgreementRequest.Builder status(AgreementStatusType status)

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

      Parameters:
      status - You can update the status for the agreement, either activating an inactive agreement or the reverse.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • localProfileId

      UpdateAgreementRequest.Builder localProfileId(String localProfileId)

      A unique identifier for the AS2 local profile.

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

      Parameters:
      localProfileId - A unique identifier for the AS2 local profile.

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

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

    • partnerProfileId

      UpdateAgreementRequest.Builder partnerProfileId(String partnerProfileId)

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

      Parameters:
      partnerProfileId - A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • baseDirectory

      UpdateAgreementRequest.Builder baseDirectory(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 .

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

    • accessRole

      UpdateAgreementRequest.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.

    • preserveFilename

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

    • preserveFilename

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

    • enforceMessageSigning

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

    • enforceMessageSigning

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

    • customDirectories

      UpdateAgreementRequest.Builder customDirectories(CustomDirectoriesType customDirectories)

      A CustomDirectoriesType structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.

      • Failed files

      • MDN files

      • Payload files

      • Status files

      • Temporary files

      Parameters:
      customDirectories - A CustomDirectoriesType structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.

      • Failed files

      • MDN files

      • Payload files

      • Status files

      • Temporary files

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

    • customDirectories

      default UpdateAgreementRequest.Builder customDirectories(Consumer<CustomDirectoriesType.Builder> customDirectories)

      A CustomDirectoriesType structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.

      • Failed files

      • MDN files

      • Payload files

      • Status files

      • Temporary files

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customDirectories(CustomDirectoriesType).

      Parameters:
      customDirectories - a consumer that will call methods on CustomDirectoriesType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      UpdateAgreementRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateAgreementRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.