Struct aws_sdk_transfer::types::DescribedConnector

#[non_exhaustive]
pub struct DescribedConnector {
    pub arn: String,
    pub connector_id: Option<String>,
    pub url: Option<String>,
    pub as2_config: Option<As2ConnectorConfig>,
    pub access_role: Option<String>,
    pub logging_role: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub sftp_config: Option<SftpConnectorConfig>,
    pub service_managed_egress_ip_addresses: Option<Vec<String>>,
    pub security_policy_name: Option<String>,
}

Describes the parameters for the connector, as identified by the ConnectorId.

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.

arn: String

The unique Amazon Resource Name (ARN) for the connector.

connector_id: Option<String>

The unique identifier for the connector.

url: Option<String>

The URL of the partner's AS2 or SFTP endpoint.

as2_config: Option<As2ConnectorConfig>

A structure that contains the parameters for an AS2 connector object.

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.

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

tags: Option<Vec<Tag>>

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

sftp_config: Option<SftpConnectorConfig>

A structure that contains the parameters for an SFTP connector object.

service_managed_egress_ip_addresses: Option<Vec<String>>

The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.

security_policy_name: Option<String>

The text name of the security policy for the specified connector.

Implementations

impl DescribedConnector

pub fn arn(&self) -> &str

The unique Amazon Resource Name (ARN) for the connector.

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

The unique identifier for the connector.

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

The URL of the partner's AS2 or SFTP endpoint.

pub fn as2_config(&self) -> Option<&As2ConnectorConfig>

A structure that contains the parameters for an AS2 connector object.

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 logging_role(&self) -> Option<&str>

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.

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

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

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 sftp_config(&self) -> Option<&SftpConnectorConfig>

A structure that contains the parameters for an SFTP connector object.

pub fn service_managed_egress_ip_addresses(&self) -> &[String]

The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.

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

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

The text name of the security policy for the specified connector.

impl DescribedConnector

pub fn builder() -> DescribedConnectorBuilder

Creates a new builder-style object to manufacture DescribedConnector.

Trait Implementations

impl Clone for DescribedConnector

fn clone(&self) -> DescribedConnector

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribedConnector

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

Formats the value using the given formatter.

impl PartialEq for DescribedConnector

fn eq(&self, other: &DescribedConnector) -> 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 DescribedConnector