#[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>>,
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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 /DOC-EXAMPLE-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
.
Key-value pairs that can be used to group and search for agreements.
Implementations§
source§impl CreateAgreementInput
impl CreateAgreementInput
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A name or short description to identify the agreement.
sourcepub fn server_id(&self) -> Option<&str>
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.
sourcepub fn local_profile_id(&self) -> Option<&str>
pub fn local_profile_id(&self) -> Option<&str>
A unique identifier for the AS2 local profile.
sourcepub fn partner_profile_id(&self) -> Option<&str>
pub fn partner_profile_id(&self) -> Option<&str>
A unique identifier for the partner profile used in the agreement.
sourcepub fn base_directory(&self) -> Option<&str>
pub fn base_directory(&self) -> Option<&str>
The landing directory (folder) for files transferred by using the AS2 protocol.
A BaseDirectory
example is /DOC-EXAMPLE-BUCKET/home/mydirectory
.
sourcepub fn access_role(&self) -> Option<&str>
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.
sourcepub fn status(&self) -> Option<&AgreementStatusType>
pub fn status(&self) -> Option<&AgreementStatusType>
The status of the agreement. The agreement can be either ACTIVE
or INACTIVE
.
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()
.
source§impl CreateAgreementInput
impl CreateAgreementInput
sourcepub fn builder() -> CreateAgreementInputBuilder
pub fn builder() -> CreateAgreementInputBuilder
Creates a new builder-style object to manufacture CreateAgreementInput
.
Trait Implementations§
source§impl Clone for CreateAgreementInput
impl Clone for CreateAgreementInput
source§fn clone(&self) -> CreateAgreementInput
fn clone(&self) -> CreateAgreementInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CreateAgreementInput
impl Debug for CreateAgreementInput
source§impl PartialEq for CreateAgreementInput
impl PartialEq for CreateAgreementInput
source§fn eq(&self, other: &CreateAgreementInput) -> bool
fn eq(&self, other: &CreateAgreementInput) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for CreateAgreementInput
Auto Trait Implementations§
impl Freeze for CreateAgreementInput
impl RefUnwindSafe for CreateAgreementInput
impl Send for CreateAgreementInput
impl Sync for CreateAgreementInput
impl Unpin for CreateAgreementInput
impl UnwindSafe for CreateAgreementInput
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more