com.amazonaws.services.transfer.model

Class CreateConnectorRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.transfer.model.CreateConnectorRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateConnectorRequest
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
CreateConnectorRequest()

Method Summary

Modifier and Type	Method and Description
CreateConnectorRequest	clone()
boolean	equals(Object obj)
String	getAccessRole() With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths.
As2ConnectorConfig	getAs2Config() A structure that contains the parameters for an AS2 connector object.
String	getLoggingRole() The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events.
SftpConnectorConfig	getSftpConfig() A structure that contains the parameters for an SFTP connector object.
List<Tag>	getTags() Key-value pairs that can be used to group and search for connectors.
String	getUrl() The URL of the partner's AS2 or SFTP endpoint.
int	hashCode()
void	setAccessRole(String accessRole) With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths.
void	setAs2Config(As2ConnectorConfig as2Config) A structure that contains the parameters for an AS2 connector object.
void	setLoggingRole(String loggingRole) The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events.
void	setSftpConfig(SftpConnectorConfig sftpConfig) A structure that contains the parameters for an SFTP connector object.
void	setTags(Collection<Tag> tags) Key-value pairs that can be used to group and search for connectors.
void	setUrl(String url) The URL of the partner's AS2 or SFTP endpoint.
String	toString() Returns a string representation of this object.
CreateConnectorRequest	withAccessRole(String accessRole) With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths.
CreateConnectorRequest	withAs2Config(As2ConnectorConfig as2Config) A structure that contains the parameters for an AS2 connector object.
CreateConnectorRequest	withLoggingRole(String loggingRole) The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events.
CreateConnectorRequest	withSftpConfig(SftpConnectorConfig sftpConfig) A structure that contains the parameters for an SFTP connector object.
CreateConnectorRequest	withTags(Collection<Tag> tags) Key-value pairs that can be used to group and search for connectors.
CreateConnectorRequest	withTags(Tag... tags) Key-value pairs that can be used to group and search for connectors.
CreateConnectorRequest	withUrl(String url) The URL of the partner's AS2 or SFTP endpoint.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, 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

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

Constructor Detail

CreateConnectorRequest

public CreateConnectorRequest()

Method Detail

setUrl

public void setUrl(String url)

The URL of the partner's AS2 or SFTP endpoint.

Parameters:

url - The URL of the partner's AS2 or SFTP endpoint.

getUrl

public String getUrl()

The URL of the partner's AS2 or SFTP endpoint.

Returns:

The URL of the partner's AS2 or SFTP endpoint.

withUrl

public CreateConnectorRequest withUrl(String url)

The URL of the partner's AS2 or SFTP endpoint.

Parameters:

url - The URL of the partner's AS2 or SFTP endpoint.

Returns:

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

setAs2Config

public void setAs2Config(As2ConnectorConfig as2Config)

A structure that contains the parameters for an AS2 connector object.

Parameters:

as2Config - A structure that contains the parameters for an AS2 connector object.

getAs2Config

public As2ConnectorConfig getAs2Config()

A structure that contains the parameters for an AS2 connector object.

Returns:

A structure that contains the parameters for an AS2 connector object.

withAs2Config

public CreateConnectorRequest withAs2Config(As2ConnectorConfig as2Config)

A structure that contains the parameters for an AS2 connector object.

Parameters:

as2Config - A structure that contains the parameters for an AS2 connector object.

Returns:

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

setAccessRole

public void setAccessRole(String accessRole)

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.

Parameters:

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

getAccessRole

public String getAccessRole()

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.

Returns:

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.

withAccessRole

public CreateConnectorRequest withAccessRole(String accessRole)

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.

Parameters:

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

Returns:

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

setLoggingRole

public void setLoggingRole(String loggingRole)

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.

Parameters:

loggingRole - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.

getLoggingRole

public String getLoggingRole()

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.

Returns:

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.

withLoggingRole

public CreateConnectorRequest withLoggingRole(String loggingRole)

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.

Parameters:

loggingRole - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.

Returns:

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

getTags

public List<Tag> getTags()

Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.

Returns:

Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.

setTags

public void setTags(Collection<Tag> tags)

Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.

Parameters:

tags - Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.

withTags

public CreateConnectorRequest withTags(Tag... tags)

Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.

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 connectors. Tags are metadata attached to connectors for any purpose.

Returns:

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

withTags

public CreateConnectorRequest withTags(Collection<Tag> tags)

Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.

Parameters:

tags - Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.

Returns:

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

setSftpConfig

public void setSftpConfig(SftpConnectorConfig sftpConfig)

A structure that contains the parameters for an SFTP connector object.

Parameters:

sftpConfig - A structure that contains the parameters for an SFTP connector object.

getSftpConfig

public SftpConnectorConfig getSftpConfig()

A structure that contains the parameters for an SFTP connector object.

Returns:

A structure that contains the parameters for an SFTP connector object.

withSftpConfig

public CreateConnectorRequest withSftpConfig(SftpConnectorConfig sftpConfig)

A structure that contains the parameters for an SFTP connector object.

Parameters:

sftpConfig - A structure that contains the parameters for an SFTP connector object.

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 CreateConnectorRequest clone()

Overrides:

clone in class AmazonWebServiceRequest