Struct aws_sdk_transfer::types::builders::DescribedConnectorBuilder
source · #[non_exhaustive]pub struct DescribedConnectorBuilder { /* private fields */ }
Expand description
A builder for DescribedConnector
.
Implementations§
source§impl DescribedConnectorBuilder
impl DescribedConnectorBuilder
sourcepub fn arn(self, input: impl Into<String>) -> Self
pub fn arn(self, input: impl Into<String>) -> Self
The unique Amazon Resource Name (ARN) for the connector.
This field is required.sourcepub fn set_arn(self, input: Option<String>) -> Self
pub fn set_arn(self, input: Option<String>) -> Self
The unique Amazon Resource Name (ARN) for the connector.
sourcepub fn get_arn(&self) -> &Option<String>
pub fn get_arn(&self) -> &Option<String>
The unique Amazon Resource Name (ARN) for the connector.
sourcepub fn connector_id(self, input: impl Into<String>) -> Self
pub fn connector_id(self, input: impl Into<String>) -> Self
The unique identifier for the connector.
sourcepub fn set_connector_id(self, input: Option<String>) -> Self
pub fn set_connector_id(self, input: Option<String>) -> Self
The unique identifier for the connector.
sourcepub fn get_connector_id(&self) -> &Option<String>
pub fn get_connector_id(&self) -> &Option<String>
The unique identifier for the connector.
sourcepub fn url(self, input: impl Into<String>) -> Self
pub fn url(self, input: impl Into<String>) -> Self
The URL of the partner's AS2 or SFTP endpoint.
sourcepub fn set_url(self, input: Option<String>) -> Self
pub fn set_url(self, input: Option<String>) -> Self
The URL of the partner's AS2 or SFTP endpoint.
sourcepub fn as2_config(self, input: As2ConnectorConfig) -> Self
pub fn as2_config(self, input: As2ConnectorConfig) -> Self
A structure that contains the parameters for an AS2 connector object.
sourcepub fn set_as2_config(self, input: Option<As2ConnectorConfig>) -> Self
pub fn set_as2_config(self, input: Option<As2ConnectorConfig>) -> Self
A structure that contains the parameters for an AS2 connector object.
sourcepub fn get_as2_config(&self) -> &Option<As2ConnectorConfig>
pub fn get_as2_config(&self) -> &Option<As2ConnectorConfig>
A structure that contains the parameters for an AS2 connector object.
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 logging_role(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_logging_role(self, input: Option<String>) -> Self
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.
sourcepub fn get_logging_role(&self) -> &Option<String>
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.
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 connectors.
Key-value pairs that can be used to group and search for connectors.
Key-value pairs that can be used to group and search for connectors.
sourcepub fn sftp_config(self, input: SftpConnectorConfig) -> Self
pub fn sftp_config(self, input: SftpConnectorConfig) -> Self
A structure that contains the parameters for an SFTP connector object.
sourcepub fn set_sftp_config(self, input: Option<SftpConnectorConfig>) -> Self
pub fn set_sftp_config(self, input: Option<SftpConnectorConfig>) -> Self
A structure that contains the parameters for an SFTP connector object.
sourcepub fn get_sftp_config(&self) -> &Option<SftpConnectorConfig>
pub fn get_sftp_config(&self) -> &Option<SftpConnectorConfig>
A structure that contains the parameters for an SFTP connector object.
sourcepub fn service_managed_egress_ip_addresses(
self,
input: impl Into<String>,
) -> Self
pub fn service_managed_egress_ip_addresses( self, input: impl Into<String>, ) -> Self
Appends an item to service_managed_egress_ip_addresses
.
To override the contents of this collection use set_service_managed_egress_ip_addresses
.
The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
sourcepub fn set_service_managed_egress_ip_addresses(
self,
input: Option<Vec<String>>,
) -> Self
pub fn set_service_managed_egress_ip_addresses( self, input: Option<Vec<String>>, ) -> Self
The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
sourcepub fn get_service_managed_egress_ip_addresses(&self) -> &Option<Vec<String>>
pub fn get_service_managed_egress_ip_addresses(&self) -> &Option<Vec<String>>
The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
sourcepub fn security_policy_name(self, input: impl Into<String>) -> Self
pub fn security_policy_name(self, input: impl Into<String>) -> Self
The text name of the security policy for the specified connector.
sourcepub fn set_security_policy_name(self, input: Option<String>) -> Self
pub fn set_security_policy_name(self, input: Option<String>) -> Self
The text name of the security policy for the specified connector.
sourcepub fn get_security_policy_name(&self) -> &Option<String>
pub fn get_security_policy_name(&self) -> &Option<String>
The text name of the security policy for the specified connector.
sourcepub fn build(self) -> Result<DescribedConnector, BuildError>
pub fn build(self) -> Result<DescribedConnector, BuildError>
Consumes the builder and constructs a DescribedConnector
.
This method will fail if any of the following fields are not set:
Trait Implementations§
source§impl Clone for DescribedConnectorBuilder
impl Clone for DescribedConnectorBuilder
source§fn clone(&self) -> DescribedConnectorBuilder
fn clone(&self) -> DescribedConnectorBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for DescribedConnectorBuilder
impl Debug for DescribedConnectorBuilder
source§impl Default for DescribedConnectorBuilder
impl Default for DescribedConnectorBuilder
source§fn default() -> DescribedConnectorBuilder
fn default() -> DescribedConnectorBuilder
source§impl PartialEq for DescribedConnectorBuilder
impl PartialEq for DescribedConnectorBuilder
source§fn eq(&self, other: &DescribedConnectorBuilder) -> bool
fn eq(&self, other: &DescribedConnectorBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for DescribedConnectorBuilder
Auto Trait Implementations§
impl Freeze for DescribedConnectorBuilder
impl RefUnwindSafe for DescribedConnectorBuilder
impl Send for DescribedConnectorBuilder
impl Sync for DescribedConnectorBuilder
impl Unpin for DescribedConnectorBuilder
impl UnwindSafe for DescribedConnectorBuilder
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