Struct CreateAgreementInput

#[non_exhaustive]
pub struct CreateAgreementInput {
    pub description: Option<String>,
    pub server_id: Option<String>,
    pub local_profile_id: Option<String>,
    pub partner_profile_id: Option<String>,
    pub base_directory: Option<String>,
    pub access_role: Option<String>,
    pub status: Option<AgreementStatusType>,
    pub tags: Option<Vec<Tag>>,
    pub preserve_filename: Option<PreserveFilenameType>,
    pub enforce_message_signing: Option<EnforceMessageSigningType>,
    pub custom_directories: Option<CustomDirectoriesType>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

description: Option<String>

A name or short description to identify the agreement.

server_id: Option<String>

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

local_profile_id: Option<String>

A unique identifier for the AS2 local profile.

partner_profile_id: Option<String>

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

base_directory: Option<String>

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

A BaseDirectory example is /amzn-s3-demo-bucket/home/mydirectory.

access_role: 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.

status: Option<AgreementStatusType>

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

tags: Option<Vec<Tag>>

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

preserve_filename: Option<PreserveFilenameType>

Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.

• ENABLED: the filename provided by your trading parter is preserved when the file is saved.

• DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as described in File names and locations.

enforce_message_signing: Option<EnforceMessageSigningType>

Determines whether or not unsigned messages from your trading partners will be accepted.

• ENABLED: Transfer Family rejects unsigned messages from your trading partner.

• DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.

custom_directories: Option<CustomDirectoriesType>

A CustomDirectoriesType structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.

• Failed files

• MDN files

• Payload files

• Status files

• Temporary files

Implementations

impl CreateAgreementInput

pub fn description(&self) -> Option<&str>

A name or short description to identify the agreement.

pub fn server_id(&self) -> Option<&str>

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

pub fn local_profile_id(&self) -> Option<&str>

A unique identifier for the AS2 local profile.

pub fn partner_profile_id(&self) -> Option<&str>

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

pub fn base_directory(&self) -> Option<&str>

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

A BaseDirectory example is /amzn-s3-demo-bucket/home/mydirectory.

pub fn access_role(&self) -> Option<&str>

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 status(&self) -> Option<&AgreementStatusType>

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

pub fn tags(&self) -> &[Tag]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn preserve_filename(&self) -> Option<&PreserveFilenameType>

Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.

• ENABLED: the filename provided by your trading parter is preserved when the file is saved.

• DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as described in File names and locations.

pub fn enforce_message_signing(&self) -> Option<&EnforceMessageSigningType>

Determines whether or not unsigned messages from your trading partners will be accepted.

• ENABLED: Transfer Family rejects unsigned messages from your trading partner.

• DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.

pub fn custom_directories(&self) -> Option<&CustomDirectoriesType>

A CustomDirectoriesType structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.

• Failed files

• MDN files

• Payload files

• Status files

• Temporary files

impl CreateAgreementInput

pub fn builder() -> CreateAgreementInputBuilder

Creates a new builder-style object to manufacture CreateAgreementInput.

Trait Implementations

impl Clone for CreateAgreementInput

fn clone(&self) -> CreateAgreementInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateAgreementInput

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

Formats the value using the given formatter.

impl PartialEq for CreateAgreementInput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for CreateAgreementInput