#[non_exhaustive]pub struct CreateAgreementInputBuilder { /* private fields */ }
Expand description
A builder for CreateAgreementInput
.
Implementations§
source§impl CreateAgreementInputBuilder
impl CreateAgreementInputBuilder
sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A name or short description to identify the agreement.
sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A name or short description to identify the agreement.
sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A name or short description to identify the agreement.
sourcepub fn server_id(self, input: impl Into<String>) -> Self
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.sourcepub fn set_server_id(self, input: Option<String>) -> Self
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.
sourcepub fn get_server_id(&self) -> &Option<String>
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.
sourcepub fn local_profile_id(self, input: impl Into<String>) -> Self
pub fn local_profile_id(self, input: impl Into<String>) -> Self
A unique identifier for the AS2 local profile.
This field is required.sourcepub fn set_local_profile_id(self, input: Option<String>) -> Self
pub fn set_local_profile_id(self, input: Option<String>) -> Self
A unique identifier for the AS2 local profile.
sourcepub fn get_local_profile_id(&self) -> &Option<String>
pub fn get_local_profile_id(&self) -> &Option<String>
A unique identifier for the AS2 local profile.
sourcepub fn partner_profile_id(self, input: impl Into<String>) -> Self
pub fn partner_profile_id(self, input: impl Into<String>) -> Self
A unique identifier for the partner profile used in the agreement.
This field is required.sourcepub fn set_partner_profile_id(self, input: Option<String>) -> Self
pub fn set_partner_profile_id(self, input: Option<String>) -> Self
A unique identifier for the partner profile used in the agreement.
sourcepub fn get_partner_profile_id(&self) -> &Option<String>
pub fn get_partner_profile_id(&self) -> &Option<String>
A unique identifier for the partner profile used in the agreement.
sourcepub fn base_directory(self, input: impl Into<String>) -> Self
pub fn base_directory(self, input: impl Into<String>) -> Self
The landing directory (folder) for files transferred by using the AS2 protocol.
A BaseDirectory
example is /DOC-EXAMPLE-BUCKET/home/mydirectory
.
sourcepub fn set_base_directory(self, input: Option<String>) -> Self
pub fn set_base_directory(self, input: Option<String>) -> Self
The landing directory (folder) for files transferred by using the AS2 protocol.
A BaseDirectory
example is /DOC-EXAMPLE-BUCKET/home/mydirectory
.
sourcepub fn get_base_directory(&self) -> &Option<String>
pub fn get_base_directory(&self) -> &Option<String>
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, input: impl Into<String>) -> Self
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.
sourcepub fn set_access_role(self, input: Option<String>) -> Self
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.
sourcepub fn get_access_role(&self) -> &Option<String>
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.
sourcepub fn status(self, input: AgreementStatusType) -> Self
pub fn status(self, input: AgreementStatusType) -> Self
The status of the agreement. The agreement can be either ACTIVE
or INACTIVE
.
sourcepub fn set_status(self, input: Option<AgreementStatusType>) -> Self
pub fn set_status(self, input: Option<AgreementStatusType>) -> Self
The status of the agreement. The agreement can be either ACTIVE
or INACTIVE
.
sourcepub fn get_status(&self) -> &Option<AgreementStatusType>
pub fn get_status(&self) -> &Option<AgreementStatusType>
The status of the agreement. The agreement can be either ACTIVE
or INACTIVE
.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
Key-value pairs that can be used to group and search for agreements.
Key-value pairs that can be used to group and search for agreements.
Key-value pairs that can be used to group and search for agreements.
sourcepub fn build(self) -> Result<CreateAgreementInput, BuildError>
pub fn build(self) -> Result<CreateAgreementInput, BuildError>
Consumes the builder and constructs a CreateAgreementInput
.
source§impl CreateAgreementInputBuilder
impl CreateAgreementInputBuilder
sourcepub async fn send_with(
self,
client: &Client,
) -> Result<CreateAgreementOutput, SdkError<CreateAgreementError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<CreateAgreementOutput, SdkError<CreateAgreementError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
source§impl Clone for CreateAgreementInputBuilder
impl Clone for CreateAgreementInputBuilder
source§fn clone(&self) -> CreateAgreementInputBuilder
fn clone(&self) -> CreateAgreementInputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CreateAgreementInputBuilder
impl Debug for CreateAgreementInputBuilder
source§impl Default for CreateAgreementInputBuilder
impl Default for CreateAgreementInputBuilder
source§fn default() -> CreateAgreementInputBuilder
fn default() -> CreateAgreementInputBuilder
source§impl PartialEq for CreateAgreementInputBuilder
impl PartialEq for CreateAgreementInputBuilder
source§fn eq(&self, other: &CreateAgreementInputBuilder) -> bool
fn eq(&self, other: &CreateAgreementInputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for CreateAgreementInputBuilder
Auto Trait Implementations§
impl Freeze for CreateAgreementInputBuilder
impl RefUnwindSafe for CreateAgreementInputBuilder
impl Send for CreateAgreementInputBuilder
impl Sync for CreateAgreementInputBuilder
impl Unpin for CreateAgreementInputBuilder
impl UnwindSafe for CreateAgreementInputBuilder
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