com.amazonaws.services.transfer.model

Class CreateAgreementRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.transfer.model.CreateAgreementRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateAgreementRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateAgreementRequest()

Method Summary

Modifier and Type	Method and Description
CreateAgreementRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAccessRole() Connectors are used to send files using either the AS2 or SFTP protocol.
String	getBaseDirectory() The landing directory (folder) for files transferred by using the AS2 protocol.
String	getDescription() A name or short description to identify the agreement.
String	getLocalProfileId() A unique identifier for the AS2 local profile.
String	getPartnerProfileId() A unique identifier for the partner profile used in the agreement.
String	getServerId() A system-assigned unique identifier for a server instance.
String	getStatus() The status of the agreement.
List<Tag>	getTags() Key-value pairs that can be used to group and search for agreements.
int	hashCode()
void	setAccessRole(String accessRole) Connectors are used to send files using either the AS2 or SFTP protocol.
void	setBaseDirectory(String baseDirectory) The landing directory (folder) for files transferred by using the AS2 protocol.
void	setDescription(String description) A name or short description to identify the agreement.
void	setLocalProfileId(String localProfileId) A unique identifier for the AS2 local profile.
void	setPartnerProfileId(String partnerProfileId) A unique identifier for the partner profile used in the agreement.
void	setServerId(String serverId) A system-assigned unique identifier for a server instance.
void	setStatus(String status) The status of the agreement.
void	setTags(Collection<Tag> tags) Key-value pairs that can be used to group and search for agreements.
String	toString() Returns a string representation of this object.
CreateAgreementRequest	withAccessRole(String accessRole) Connectors are used to send files using either the AS2 or SFTP protocol.
CreateAgreementRequest	withBaseDirectory(String baseDirectory) The landing directory (folder) for files transferred by using the AS2 protocol.
CreateAgreementRequest	withDescription(String description) A name or short description to identify the agreement.
CreateAgreementRequest	withLocalProfileId(String localProfileId) A unique identifier for the AS2 local profile.
CreateAgreementRequest	withPartnerProfileId(String partnerProfileId) A unique identifier for the partner profile used in the agreement.
CreateAgreementRequest	withServerId(String serverId) A system-assigned unique identifier for a server instance.
CreateAgreementRequest	withStatus(AgreementStatusType status) The status of the agreement.
CreateAgreementRequest	withStatus(String status) The status of the agreement.
CreateAgreementRequest	withTags(Collection<Tag> tags) Key-value pairs that can be used to group and search for agreements.
CreateAgreementRequest	withTags(Tag... tags) Key-value pairs that can be used to group and search for agreements.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateAgreementRequest

public CreateAgreementRequest()

Method Detail

setDescription

public void setDescription(String description)

A name or short description to identify the agreement.

Parameters:

description - A name or short description to identify the agreement.

getDescription

public String getDescription()

A name or short description to identify the agreement.

Returns:

A name or short description to identify the agreement.

withDescription

public CreateAgreementRequest withDescription(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.

setServerId

public void setServerId(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.

getServerId

public String getServerId()

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.

withServerId

public CreateAgreementRequest withServerId(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.

setLocalProfileId

public void setLocalProfileId(String localProfileId)

A unique identifier for the AS2 local profile.

Parameters:

localProfileId - A unique identifier for the AS2 local profile.

getLocalProfileId

public String getLocalProfileId()

A unique identifier for the AS2 local profile.

Returns:

A unique identifier for the AS2 local profile.

withLocalProfileId

public CreateAgreementRequest withLocalProfileId(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.

setPartnerProfileId

public void setPartnerProfileId(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.

getPartnerProfileId

public String getPartnerProfileId()

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

Returns:

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

withPartnerProfileId

public CreateAgreementRequest withPartnerProfileId(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.

setBaseDirectory

public void setBaseDirectory(String baseDirectory)

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

A BaseDirectory example is /DOC-EXAMPLE-BUCKET/home/mydirectory.

Parameters:

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

A BaseDirectory example is /DOC-EXAMPLE-BUCKET/home/mydirectory.

getBaseDirectory

public String getBaseDirectory()

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

A BaseDirectory example is /DOC-EXAMPLE-BUCKET/home/mydirectory.

Returns:

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

A BaseDirectory example is /DOC-EXAMPLE-BUCKET/home/mydirectory.

withBaseDirectory

public CreateAgreementRequest withBaseDirectory(String baseDirectory)

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

A BaseDirectory example is /DOC-EXAMPLE-BUCKET/home/mydirectory.

Parameters:

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

A BaseDirectory example is /DOC-EXAMPLE-BUCKET/home/mydirectory.

Returns:

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

setAccessRole

public void setAccessRole(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.

getAccessRole

public String getAccessRole()

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.

withAccessRole

public CreateAgreementRequest withAccessRole(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.

setStatus

public void setStatus(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.

See Also:

AgreementStatusType

getStatus

public String getStatus()

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

Returns:

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

See Also:

AgreementStatusType

withStatus

public CreateAgreementRequest withStatus(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

withStatus

public CreateAgreementRequest withStatus(AgreementStatusType 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

getTags

public List<Tag> getTags()

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

Returns:

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

setTags

public void setTags(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.

withTags

public CreateAgreementRequest withTags(Tag... tags)

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

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

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.

withTags

public CreateAgreementRequest withTags(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateAgreementRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()