com.amazonaws.services.transfer.model

Class UpdateConnectorRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.transfer.model.UpdateConnectorRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
UpdateConnectorRequest	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.
As2ConnectorConfig	getAs2Config() A structure that contains the parameters for an AS2 connector object.
String	getConnectorId() The unique identifier for the connector.
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.
String	getUrl() The URL of the partner's AS2 or SFTP endpoint.
int	hashCode()
void	setAccessRole(String accessRole) Connectors are used to send files using either the AS2 or SFTP protocol.
void	setAs2Config(As2ConnectorConfig as2Config) A structure that contains the parameters for an AS2 connector object.
void	setConnectorId(String connectorId) The unique identifier for the connector.
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	setUrl(String url) The URL of the partner's AS2 or SFTP endpoint.
String	toString() Returns a string representation of this object.
UpdateConnectorRequest	withAccessRole(String accessRole) Connectors are used to send files using either the AS2 or SFTP protocol.
UpdateConnectorRequest	withAs2Config(As2ConnectorConfig as2Config) A structure that contains the parameters for an AS2 connector object.
UpdateConnectorRequest	withConnectorId(String connectorId) The unique identifier for the connector.
UpdateConnectorRequest	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.
UpdateConnectorRequest	withSftpConfig(SftpConnectorConfig sftpConfig) A structure that contains the parameters for an SFTP connector object.
UpdateConnectorRequest	withUrl(String url) The URL of the partner's AS2 or SFTP endpoint.

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

UpdateConnectorRequest

public UpdateConnectorRequest()

Method Detail

setConnectorId

public void setConnectorId(String connectorId)

The unique identifier for the connector.

Parameters:

connectorId - The unique identifier for the connector.

getConnectorId

public String getConnectorId()

The unique identifier for the connector.

Returns:

The unique identifier for the connector.

withConnectorId

public UpdateConnectorRequest withConnectorId(String connectorId)

The unique identifier for the connector.

Parameters:

connectorId - The unique identifier for the connector.

Returns:

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

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 UpdateConnectorRequest 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 UpdateConnectorRequest 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)

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

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

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 UpdateConnectorRequest 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 UpdateConnectorRequest 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()