Struct aws_sdk_transfer::operation::update_connector::builders::UpdateConnectorFluentBuilder

pub struct UpdateConnectorFluentBuilder { /* private fields */ }

Fluent builder constructing a request to UpdateConnector.

Updates some of the parameters for an existing connector. Provide the ConnectorId for the connector that you want to update, along with the new values for the parameters to update.

Implementations

impl UpdateConnectorFluentBuilder

pub fn as_input(&self) -> &UpdateConnectorInputBuilder

Access the UpdateConnector as a reference.

pub async fn send( self ) -> Result<UpdateConnectorOutput, SdkError<UpdateConnectorError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<UpdateConnectorOutput, UpdateConnectorError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn connector_id(self, input: impl Into<String>) -> Self

The unique identifier for the connector.

pub fn set_connector_id(self, input: Option<String>) -> Self

The unique identifier for the connector.

pub fn get_connector_id(&self) -> &Option<String>

The unique identifier for the connector.

pub fn url(self, input: impl Into<String>) -> Self

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

pub fn set_url(self, input: Option<String>) -> Self

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

pub fn get_url(&self) -> &Option<String>

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

pub fn as2_config(self, input: As2ConnectorConfig) -> Self

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

pub fn set_as2_config(self, input: Option<As2ConnectorConfig>) -> Self

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

pub fn get_as2_config(&self) -> &Option<As2ConnectorConfig>

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

pub fn access_role(self, input: impl Into<String>) -> Self

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.

pub fn set_access_role(self, input: Option<String>) -> Self

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.

pub fn get_access_role(&self) -> &Option<String>

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.

pub fn logging_role(self, input: impl Into<String>) -> Self

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.

pub fn set_logging_role(self, input: Option<String>) -> Self

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.

pub fn get_logging_role(&self) -> &Option<String>

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.

pub fn sftp_config(self, input: SftpConnectorConfig) -> Self

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

pub fn set_sftp_config(self, input: Option<SftpConnectorConfig>) -> Self

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

pub fn get_sftp_config(&self) -> &Option<SftpConnectorConfig>

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

Trait Implementations

impl Clone for UpdateConnectorFluentBuilder

fn clone(&self) -> UpdateConnectorFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateConnectorFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.