Struct aws_sdk_transfer::operation::update_agreement::builders::UpdateAgreementInputBuilder

#[non_exhaustive]
pub struct UpdateAgreementInputBuilder { /* private fields */ }

A builder for UpdateAgreementInput.

Implementations

impl UpdateAgreementInputBuilder

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

A unique identifier for the agreement. This identifier is returned when you create an agreement.

This field is required.

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

A unique identifier for the agreement. This identifier is returned when you create an agreement.

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

A unique identifier for the agreement. This identifier is returned when you create an agreement.

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

A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.

This field is required.

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

A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.

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

A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.

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

To replace the existing description, provide a short description for the agreement.

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

To replace the existing description, provide a short description for the agreement.

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

To replace the existing description, provide a short description for the agreement.

pub fn status(self, input: AgreementStatusType) -> Self

You can update the status for the agreement, either activating an inactive agreement or the reverse.

pub fn set_status(self, input: Option<AgreementStatusType>) -> Self

You can update the status for the agreement, either activating an inactive agreement or the reverse.

pub fn get_status(&self) -> &Option<AgreementStatusType>

You can update the status for the agreement, either activating an inactive agreement or the reverse.

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

A unique identifier for the AS2 local profile.

To change the local profile identifier, provide a new value here.

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

A unique identifier for the AS2 local profile.

To change the local profile identifier, provide a new value here.

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

A unique identifier for the AS2 local profile.

To change the local profile identifier, provide a new value here.

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

A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here.

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

A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here.

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

A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here.

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

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 .

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

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 .

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

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 .

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 build(self) -> Result<UpdateAgreementInput, BuildError>

Consumes the builder and constructs a UpdateAgreementInput.

impl UpdateAgreementInputBuilder

pub async fn send_with( self, client: &Client, ) -> Result<UpdateAgreementOutput, SdkError<UpdateAgreementError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for UpdateAgreementInputBuilder

fn clone(&self) -> UpdateAgreementInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateAgreementInputBuilder

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

Formats the value using the given formatter.

impl Default for UpdateAgreementInputBuilder

fn default() -> UpdateAgreementInputBuilder

Returns the “default value” for a type.

impl PartialEq for UpdateAgreementInputBuilder

fn eq(&self, other: &UpdateAgreementInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateAgreementInputBuilder