// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct UpdateConnectorInput {
/// <p>The unique identifier for the connector.</p>
pub connector_id: ::std::option::Option<::std::string::String>,
/// <p>The URL of the partner's AS2 or SFTP endpoint.</p>
/// <p>When creating AS2 connectors or service-managed SFTP connectors (connectors without egress configuration), you must provide a URL to specify the remote server endpoint. For VPC Lattice type connectors, the URL must be null.</p>
pub url: ::std::option::Option<::std::string::String>,
/// <p>A structure that contains the parameters for an AS2 connector object.</p>
pub as2_config: ::std::option::Option<crate::types::As2ConnectorConfig>,
/// <p>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.</p>
/// <p><b>For AS2 connectors</b></p>
/// <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent directory is <code>/bucket/dir/</code>) 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 <code>AccessRole</code> needs to provide read and write access to the parent directory of the file location used in the <code>StartFileTransfer</code> request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with <code>StartFileTransfer</code>.</p>
/// <p>If you are using Basic authentication for your AS2 connector, the access role requires the <code>secretsmanager:GetSecretValue</code> 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 <code>kms:Decrypt</code> permission for that key.</p>
/// <p><b>For SFTP connectors</b></p>
/// <p>Make sure that the access role provides read and write access to the parent directory of the file location that's used in the <code>StartFileTransfer</code> request. Additionally, make sure that the role provides <code>secretsmanager:GetSecretValue</code> permission to Secrets Manager.</p>
pub access_role: ::std::option::Option<::std::string::String>,
/// <p>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.</p>
pub logging_role: ::std::option::Option<::std::string::String>,
/// <p>A structure that contains the parameters for an SFTP connector object.</p>
pub sftp_config: ::std::option::Option<crate::types::SftpConnectorConfig>,
/// <p>Specifies the name of the security policy for the connector.</p>
pub security_policy_name: ::std::option::Option<::std::string::String>,
/// <p>Updates the egress configuration for the connector, allowing you to modify how traffic is routed from the connector to the SFTP server. Changes to VPC configuration may require connector restart.</p>
pub egress_config: ::std::option::Option<crate::types::UpdateConnectorEgressConfig>,
/// <p>Specifies the IP address type for the connector's network connections. When set to <code>IPV4</code>, the connector uses IPv4 addresses only. When set to <code>DUALSTACK</code>, the connector supports both IPv4 and IPv6 addresses, with IPv6 preferred when available.</p>
pub ip_address_type: ::std::option::Option<crate::types::ConnectorsIpAddressType>,
}
impl UpdateConnectorInput {
/// <p>The unique identifier for the connector.</p>
pub fn connector_id(&self) -> ::std::option::Option<&str> {
self.connector_id.as_deref()
}
/// <p>The URL of the partner's AS2 or SFTP endpoint.</p>
/// <p>When creating AS2 connectors or service-managed SFTP connectors (connectors without egress configuration), you must provide a URL to specify the remote server endpoint. For VPC Lattice type connectors, the URL must be null.</p>
pub fn url(&self) -> ::std::option::Option<&str> {
self.url.as_deref()
}
/// <p>A structure that contains the parameters for an AS2 connector object.</p>
pub fn as2_config(&self) -> ::std::option::Option<&crate::types::As2ConnectorConfig> {
self.as2_config.as_ref()
}
/// <p>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.</p>
/// <p><b>For AS2 connectors</b></p>
/// <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent directory is <code>/bucket/dir/</code>) 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 <code>AccessRole</code> needs to provide read and write access to the parent directory of the file location used in the <code>StartFileTransfer</code> request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with <code>StartFileTransfer</code>.</p>
/// <p>If you are using Basic authentication for your AS2 connector, the access role requires the <code>secretsmanager:GetSecretValue</code> 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 <code>kms:Decrypt</code> permission for that key.</p>
/// <p><b>For SFTP connectors</b></p>
/// <p>Make sure that the access role provides read and write access to the parent directory of the file location that's used in the <code>StartFileTransfer</code> request. Additionally, make sure that the role provides <code>secretsmanager:GetSecretValue</code> permission to Secrets Manager.</p>
pub fn access_role(&self) -> ::std::option::Option<&str> {
self.access_role.as_deref()
}
/// <p>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.</p>
pub fn logging_role(&self) -> ::std::option::Option<&str> {
self.logging_role.as_deref()
}
/// <p>A structure that contains the parameters for an SFTP connector object.</p>
pub fn sftp_config(&self) -> ::std::option::Option<&crate::types::SftpConnectorConfig> {
self.sftp_config.as_ref()
}
/// <p>Specifies the name of the security policy for the connector.</p>
pub fn security_policy_name(&self) -> ::std::option::Option<&str> {
self.security_policy_name.as_deref()
}
/// <p>Updates the egress configuration for the connector, allowing you to modify how traffic is routed from the connector to the SFTP server. Changes to VPC configuration may require connector restart.</p>
pub fn egress_config(&self) -> ::std::option::Option<&crate::types::UpdateConnectorEgressConfig> {
self.egress_config.as_ref()
}
/// <p>Specifies the IP address type for the connector's network connections. When set to <code>IPV4</code>, the connector uses IPv4 addresses only. When set to <code>DUALSTACK</code>, the connector supports both IPv4 and IPv6 addresses, with IPv6 preferred when available.</p>
pub fn ip_address_type(&self) -> ::std::option::Option<&crate::types::ConnectorsIpAddressType> {
self.ip_address_type.as_ref()
}
}
impl UpdateConnectorInput {
/// Creates a new builder-style object to manufacture [`UpdateConnectorInput`](crate::operation::update_connector::UpdateConnectorInput).
pub fn builder() -> crate::operation::update_connector::builders::UpdateConnectorInputBuilder {
crate::operation::update_connector::builders::UpdateConnectorInputBuilder::default()
}
}
/// A builder for [`UpdateConnectorInput`](crate::operation::update_connector::UpdateConnectorInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct UpdateConnectorInputBuilder {
pub(crate) connector_id: ::std::option::Option<::std::string::String>,
pub(crate) url: ::std::option::Option<::std::string::String>,
pub(crate) as2_config: ::std::option::Option<crate::types::As2ConnectorConfig>,
pub(crate) access_role: ::std::option::Option<::std::string::String>,
pub(crate) logging_role: ::std::option::Option<::std::string::String>,
pub(crate) sftp_config: ::std::option::Option<crate::types::SftpConnectorConfig>,
pub(crate) security_policy_name: ::std::option::Option<::std::string::String>,
pub(crate) egress_config: ::std::option::Option<crate::types::UpdateConnectorEgressConfig>,
pub(crate) ip_address_type: ::std::option::Option<crate::types::ConnectorsIpAddressType>,
}
impl UpdateConnectorInputBuilder {
/// <p>The unique identifier for the connector.</p>
/// This field is required.
pub fn connector_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.connector_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The unique identifier for the connector.</p>
pub fn set_connector_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.connector_id = input;
self
}
/// <p>The unique identifier for the connector.</p>
pub fn get_connector_id(&self) -> &::std::option::Option<::std::string::String> {
&self.connector_id
}
/// <p>The URL of the partner's AS2 or SFTP endpoint.</p>
/// <p>When creating AS2 connectors or service-managed SFTP connectors (connectors without egress configuration), you must provide a URL to specify the remote server endpoint. For VPC Lattice type connectors, the URL must be null.</p>
pub fn url(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.url = ::std::option::Option::Some(input.into());
self
}
/// <p>The URL of the partner's AS2 or SFTP endpoint.</p>
/// <p>When creating AS2 connectors or service-managed SFTP connectors (connectors without egress configuration), you must provide a URL to specify the remote server endpoint. For VPC Lattice type connectors, the URL must be null.</p>
pub fn set_url(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.url = input;
self
}
/// <p>The URL of the partner's AS2 or SFTP endpoint.</p>
/// <p>When creating AS2 connectors or service-managed SFTP connectors (connectors without egress configuration), you must provide a URL to specify the remote server endpoint. For VPC Lattice type connectors, the URL must be null.</p>
pub fn get_url(&self) -> &::std::option::Option<::std::string::String> {
&self.url
}
/// <p>A structure that contains the parameters for an AS2 connector object.</p>
pub fn as2_config(mut self, input: crate::types::As2ConnectorConfig) -> Self {
self.as2_config = ::std::option::Option::Some(input);
self
}
/// <p>A structure that contains the parameters for an AS2 connector object.</p>
pub fn set_as2_config(mut self, input: ::std::option::Option<crate::types::As2ConnectorConfig>) -> Self {
self.as2_config = input;
self
}
/// <p>A structure that contains the parameters for an AS2 connector object.</p>
pub fn get_as2_config(&self) -> &::std::option::Option<crate::types::As2ConnectorConfig> {
&self.as2_config
}
/// <p>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.</p>
/// <p><b>For AS2 connectors</b></p>
/// <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent directory is <code>/bucket/dir/</code>) 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 <code>AccessRole</code> needs to provide read and write access to the parent directory of the file location used in the <code>StartFileTransfer</code> request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with <code>StartFileTransfer</code>.</p>
/// <p>If you are using Basic authentication for your AS2 connector, the access role requires the <code>secretsmanager:GetSecretValue</code> 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 <code>kms:Decrypt</code> permission for that key.</p>
/// <p><b>For SFTP connectors</b></p>
/// <p>Make sure that the access role provides read and write access to the parent directory of the file location that's used in the <code>StartFileTransfer</code> request. Additionally, make sure that the role provides <code>secretsmanager:GetSecretValue</code> permission to Secrets Manager.</p>
pub fn access_role(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.access_role = ::std::option::Option::Some(input.into());
self
}
/// <p>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.</p>
/// <p><b>For AS2 connectors</b></p>
/// <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent directory is <code>/bucket/dir/</code>) 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 <code>AccessRole</code> needs to provide read and write access to the parent directory of the file location used in the <code>StartFileTransfer</code> request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with <code>StartFileTransfer</code>.</p>
/// <p>If you are using Basic authentication for your AS2 connector, the access role requires the <code>secretsmanager:GetSecretValue</code> 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 <code>kms:Decrypt</code> permission for that key.</p>
/// <p><b>For SFTP connectors</b></p>
/// <p>Make sure that the access role provides read and write access to the parent directory of the file location that's used in the <code>StartFileTransfer</code> request. Additionally, make sure that the role provides <code>secretsmanager:GetSecretValue</code> permission to Secrets Manager.</p>
pub fn set_access_role(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.access_role = input;
self
}
/// <p>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.</p>
/// <p><b>For AS2 connectors</b></p>
/// <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent directory is <code>/bucket/dir/</code>) 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 <code>AccessRole</code> needs to provide read and write access to the parent directory of the file location used in the <code>StartFileTransfer</code> request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with <code>StartFileTransfer</code>.</p>
/// <p>If you are using Basic authentication for your AS2 connector, the access role requires the <code>secretsmanager:GetSecretValue</code> 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 <code>kms:Decrypt</code> permission for that key.</p>
/// <p><b>For SFTP connectors</b></p>
/// <p>Make sure that the access role provides read and write access to the parent directory of the file location that's used in the <code>StartFileTransfer</code> request. Additionally, make sure that the role provides <code>secretsmanager:GetSecretValue</code> permission to Secrets Manager.</p>
pub fn get_access_role(&self) -> &::std::option::Option<::std::string::String> {
&self.access_role
}
/// <p>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.</p>
pub fn logging_role(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.logging_role = ::std::option::Option::Some(input.into());
self
}
/// <p>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.</p>
pub fn set_logging_role(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.logging_role = input;
self
}
/// <p>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.</p>
pub fn get_logging_role(&self) -> &::std::option::Option<::std::string::String> {
&self.logging_role
}
/// <p>A structure that contains the parameters for an SFTP connector object.</p>
pub fn sftp_config(mut self, input: crate::types::SftpConnectorConfig) -> Self {
self.sftp_config = ::std::option::Option::Some(input);
self
}
/// <p>A structure that contains the parameters for an SFTP connector object.</p>
pub fn set_sftp_config(mut self, input: ::std::option::Option<crate::types::SftpConnectorConfig>) -> Self {
self.sftp_config = input;
self
}
/// <p>A structure that contains the parameters for an SFTP connector object.</p>
pub fn get_sftp_config(&self) -> &::std::option::Option<crate::types::SftpConnectorConfig> {
&self.sftp_config
}
/// <p>Specifies the name of the security policy for the connector.</p>
pub fn security_policy_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.security_policy_name = ::std::option::Option::Some(input.into());
self
}
/// <p>Specifies the name of the security policy for the connector.</p>
pub fn set_security_policy_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.security_policy_name = input;
self
}
/// <p>Specifies the name of the security policy for the connector.</p>
pub fn get_security_policy_name(&self) -> &::std::option::Option<::std::string::String> {
&self.security_policy_name
}
/// <p>Updates the egress configuration for the connector, allowing you to modify how traffic is routed from the connector to the SFTP server. Changes to VPC configuration may require connector restart.</p>
pub fn egress_config(mut self, input: crate::types::UpdateConnectorEgressConfig) -> Self {
self.egress_config = ::std::option::Option::Some(input);
self
}
/// <p>Updates the egress configuration for the connector, allowing you to modify how traffic is routed from the connector to the SFTP server. Changes to VPC configuration may require connector restart.</p>
pub fn set_egress_config(mut self, input: ::std::option::Option<crate::types::UpdateConnectorEgressConfig>) -> Self {
self.egress_config = input;
self
}
/// <p>Updates the egress configuration for the connector, allowing you to modify how traffic is routed from the connector to the SFTP server. Changes to VPC configuration may require connector restart.</p>
pub fn get_egress_config(&self) -> &::std::option::Option<crate::types::UpdateConnectorEgressConfig> {
&self.egress_config
}
/// <p>Specifies the IP address type for the connector's network connections. When set to <code>IPV4</code>, the connector uses IPv4 addresses only. When set to <code>DUALSTACK</code>, the connector supports both IPv4 and IPv6 addresses, with IPv6 preferred when available.</p>
pub fn ip_address_type(mut self, input: crate::types::ConnectorsIpAddressType) -> Self {
self.ip_address_type = ::std::option::Option::Some(input);
self
}
/// <p>Specifies the IP address type for the connector's network connections. When set to <code>IPV4</code>, the connector uses IPv4 addresses only. When set to <code>DUALSTACK</code>, the connector supports both IPv4 and IPv6 addresses, with IPv6 preferred when available.</p>
pub fn set_ip_address_type(mut self, input: ::std::option::Option<crate::types::ConnectorsIpAddressType>) -> Self {
self.ip_address_type = input;
self
}
/// <p>Specifies the IP address type for the connector's network connections. When set to <code>IPV4</code>, the connector uses IPv4 addresses only. When set to <code>DUALSTACK</code>, the connector supports both IPv4 and IPv6 addresses, with IPv6 preferred when available.</p>
pub fn get_ip_address_type(&self) -> &::std::option::Option<crate::types::ConnectorsIpAddressType> {
&self.ip_address_type
}
/// Consumes the builder and constructs a [`UpdateConnectorInput`](crate::operation::update_connector::UpdateConnectorInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::update_connector::UpdateConnectorInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::update_connector::UpdateConnectorInput {
connector_id: self.connector_id,
url: self.url,
as2_config: self.as2_config,
access_role: self.access_role,
logging_role: self.logging_role,
sftp_config: self.sftp_config,
security_policy_name: self.security_policy_name,
egress_config: self.egress_config,
ip_address_type: self.ip_address_type,
})
}
}