software.amazon.awssdk.services.transfer.model

Class UpdateAgreementRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.transfer.model.TransferRequest

software.amazon.awssdk.services.transfer.model.UpdateAgreementRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateAgreementRequest.Builder,UpdateAgreementRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateAgreementRequest
extends TransferRequest
implements ToCopyableBuilder<UpdateAgreementRequest.Builder,UpdateAgreementRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateAgreementRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	accessRole() Connectors are used to send files using either the AS2 or SFTP protocol.
String	agreementId() A unique identifier for the agreement.
String	baseDirectory() To change the landing directory (folder) for files that are transferred, provide the bucket folder that you want to use; for example, /DOC-EXAMPLE-BUCKET/home/mydirectory .
static UpdateAgreementRequest.Builder	builder()
String	description() To replace the existing description, provide a short description for the agreement.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	localProfileId() A unique identifier for the AS2 local profile.
String	partnerProfileId() A unique identifier for the partner profile.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateAgreementRequest.Builder>	serializableBuilderClass()
String	serverId() A system-assigned unique identifier for a server instance.
AgreementStatusType	status() You can update the status for the agreement, either activating an inactive agreement or the reverse.
String	statusAsString() You can update the status for the agreement, either activating an inactive agreement or the reverse.
UpdateAgreementRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

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, /DOC-EXAMPLE-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, /DOC-EXAMPLE-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.

toBuilder

public UpdateAgreementRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateAgreementRequest.Builder,UpdateAgreementRequest>

Specified by:

toBuilder in class TransferRequest

builder

public static UpdateAgreementRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateAgreementRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo