1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
// 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>
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>,
}
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>
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()
}
}
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).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
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>,
}
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>
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>
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>
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
}
/// 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,
})
}
}