aws_sdk_transfer/operation/create_agreement/_create_agreement_input.rs
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 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
// 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 CreateAgreementInput {
/// <p>A name or short description to identify the agreement.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.</p>
pub server_id: ::std::option::Option<::std::string::String>,
/// <p>A unique identifier for the AS2 local profile.</p>
pub local_profile_id: ::std::option::Option<::std::string::String>,
/// <p>A unique identifier for the partner profile used in the agreement.</p>
pub partner_profile_id: ::std::option::Option<::std::string::String>,
/// <p>The landing directory (folder) for files transferred by using the AS2 protocol.</p>
/// <p>A <code>BaseDirectory</code> example is <code>/<i>amzn-s3-demo-bucket</i>/home/mydirectory</code>.</p>
pub base_directory: ::std::option::Option<::std::string::String>,
/// <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 status of the agreement. The agreement can be either <code>ACTIVE</code> or <code>INACTIVE</code>.</p>
pub status: ::std::option::Option<crate::types::AgreementStatusType>,
/// <p>Key-value pairs that can be used to group and search for agreements.</p>
pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
/// <p>Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.</p>
/// <ul>
/// <li>
/// <p><code>ENABLED</code>: the filename provided by your trading parter is preserved when the file is saved.</p></li>
/// <li>
/// <p><code>DISABLED</code> (default value): when Transfer Family saves the file, the filename is adjusted, as described in <a href="https://docs.aws.amazon.com/transfer/latest/userguide/send-as2-messages.html#file-names-as2">File names and locations</a>.</p></li>
/// </ul>
pub preserve_filename: ::std::option::Option<crate::types::PreserveFilenameType>,
/// <p>Determines whether or not unsigned messages from your trading partners will be accepted.</p>
/// <ul>
/// <li>
/// <p><code>ENABLED</code>: Transfer Family rejects unsigned messages from your trading partner.</p></li>
/// <li>
/// <p><code>DISABLED</code> (default value): Transfer Family accepts unsigned messages from your trading partner.</p></li>
/// </ul>
pub enforce_message_signing: ::std::option::Option<crate::types::EnforceMessageSigningType>,
/// <p>A <code>CustomDirectoriesType</code> structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.</p>
/// <ul>
/// <li>
/// <p>Failed files</p></li>
/// <li>
/// <p>MDN files</p></li>
/// <li>
/// <p>Payload files</p></li>
/// <li>
/// <p>Status files</p></li>
/// <li>
/// <p>Temporary files</p></li>
/// </ul>
pub custom_directories: ::std::option::Option<crate::types::CustomDirectoriesType>,
}
impl CreateAgreementInput {
/// <p>A name or short description to identify the agreement.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.</p>
pub fn server_id(&self) -> ::std::option::Option<&str> {
self.server_id.as_deref()
}
/// <p>A unique identifier for the AS2 local profile.</p>
pub fn local_profile_id(&self) -> ::std::option::Option<&str> {
self.local_profile_id.as_deref()
}
/// <p>A unique identifier for the partner profile used in the agreement.</p>
pub fn partner_profile_id(&self) -> ::std::option::Option<&str> {
self.partner_profile_id.as_deref()
}
/// <p>The landing directory (folder) for files transferred by using the AS2 protocol.</p>
/// <p>A <code>BaseDirectory</code> example is <code>/<i>amzn-s3-demo-bucket</i>/home/mydirectory</code>.</p>
pub fn base_directory(&self) -> ::std::option::Option<&str> {
self.base_directory.as_deref()
}
/// <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 status of the agreement. The agreement can be either <code>ACTIVE</code> or <code>INACTIVE</code>.</p>
pub fn status(&self) -> ::std::option::Option<&crate::types::AgreementStatusType> {
self.status.as_ref()
}
/// <p>Key-value pairs that can be used to group and search for agreements.</p>
///
/// 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 tags(&self) -> &[crate::types::Tag] {
self.tags.as_deref().unwrap_or_default()
}
/// <p>Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.</p>
/// <ul>
/// <li>
/// <p><code>ENABLED</code>: the filename provided by your trading parter is preserved when the file is saved.</p></li>
/// <li>
/// <p><code>DISABLED</code> (default value): when Transfer Family saves the file, the filename is adjusted, as described in <a href="https://docs.aws.amazon.com/transfer/latest/userguide/send-as2-messages.html#file-names-as2">File names and locations</a>.</p></li>
/// </ul>
pub fn preserve_filename(&self) -> ::std::option::Option<&crate::types::PreserveFilenameType> {
self.preserve_filename.as_ref()
}
/// <p>Determines whether or not unsigned messages from your trading partners will be accepted.</p>
/// <ul>
/// <li>
/// <p><code>ENABLED</code>: Transfer Family rejects unsigned messages from your trading partner.</p></li>
/// <li>
/// <p><code>DISABLED</code> (default value): Transfer Family accepts unsigned messages from your trading partner.</p></li>
/// </ul>
pub fn enforce_message_signing(&self) -> ::std::option::Option<&crate::types::EnforceMessageSigningType> {
self.enforce_message_signing.as_ref()
}
/// <p>A <code>CustomDirectoriesType</code> structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.</p>
/// <ul>
/// <li>
/// <p>Failed files</p></li>
/// <li>
/// <p>MDN files</p></li>
/// <li>
/// <p>Payload files</p></li>
/// <li>
/// <p>Status files</p></li>
/// <li>
/// <p>Temporary files</p></li>
/// </ul>
pub fn custom_directories(&self) -> ::std::option::Option<&crate::types::CustomDirectoriesType> {
self.custom_directories.as_ref()
}
}
impl CreateAgreementInput {
/// Creates a new builder-style object to manufacture [`CreateAgreementInput`](crate::operation::create_agreement::CreateAgreementInput).
pub fn builder() -> crate::operation::create_agreement::builders::CreateAgreementInputBuilder {
crate::operation::create_agreement::builders::CreateAgreementInputBuilder::default()
}
}
/// A builder for [`CreateAgreementInput`](crate::operation::create_agreement::CreateAgreementInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateAgreementInputBuilder {
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) server_id: ::std::option::Option<::std::string::String>,
pub(crate) local_profile_id: ::std::option::Option<::std::string::String>,
pub(crate) partner_profile_id: ::std::option::Option<::std::string::String>,
pub(crate) base_directory: ::std::option::Option<::std::string::String>,
pub(crate) access_role: ::std::option::Option<::std::string::String>,
pub(crate) status: ::std::option::Option<crate::types::AgreementStatusType>,
pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
pub(crate) preserve_filename: ::std::option::Option<crate::types::PreserveFilenameType>,
pub(crate) enforce_message_signing: ::std::option::Option<crate::types::EnforceMessageSigningType>,
pub(crate) custom_directories: ::std::option::Option<crate::types::CustomDirectoriesType>,
}
impl CreateAgreementInputBuilder {
/// <p>A name or short description to identify the agreement.</p>
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.description = ::std::option::Option::Some(input.into());
self
}
/// <p>A name or short description to identify the agreement.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>A name or short description to identify the agreement.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.</p>
/// This field is required.
pub fn server_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.server_id = ::std::option::Option::Some(input.into());
self
}
/// <p>A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.</p>
pub fn set_server_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.server_id = input;
self
}
/// <p>A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.</p>
pub fn get_server_id(&self) -> &::std::option::Option<::std::string::String> {
&self.server_id
}
/// <p>A unique identifier for the AS2 local profile.</p>
/// This field is required.
pub fn local_profile_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.local_profile_id = ::std::option::Option::Some(input.into());
self
}
/// <p>A unique identifier for the AS2 local profile.</p>
pub fn set_local_profile_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.local_profile_id = input;
self
}
/// <p>A unique identifier for the AS2 local profile.</p>
pub fn get_local_profile_id(&self) -> &::std::option::Option<::std::string::String> {
&self.local_profile_id
}
/// <p>A unique identifier for the partner profile used in the agreement.</p>
/// This field is required.
pub fn partner_profile_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.partner_profile_id = ::std::option::Option::Some(input.into());
self
}
/// <p>A unique identifier for the partner profile used in the agreement.</p>
pub fn set_partner_profile_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.partner_profile_id = input;
self
}
/// <p>A unique identifier for the partner profile used in the agreement.</p>
pub fn get_partner_profile_id(&self) -> &::std::option::Option<::std::string::String> {
&self.partner_profile_id
}
/// <p>The landing directory (folder) for files transferred by using the AS2 protocol.</p>
/// <p>A <code>BaseDirectory</code> example is <code>/<i>amzn-s3-demo-bucket</i>/home/mydirectory</code>.</p>
pub fn base_directory(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.base_directory = ::std::option::Option::Some(input.into());
self
}
/// <p>The landing directory (folder) for files transferred by using the AS2 protocol.</p>
/// <p>A <code>BaseDirectory</code> example is <code>/<i>amzn-s3-demo-bucket</i>/home/mydirectory</code>.</p>
pub fn set_base_directory(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.base_directory = input;
self
}
/// <p>The landing directory (folder) for files transferred by using the AS2 protocol.</p>
/// <p>A <code>BaseDirectory</code> example is <code>/<i>amzn-s3-demo-bucket</i>/home/mydirectory</code>.</p>
pub fn get_base_directory(&self) -> &::std::option::Option<::std::string::String> {
&self.base_directory
}
/// <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>
/// This field is required.
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 status of the agreement. The agreement can be either <code>ACTIVE</code> or <code>INACTIVE</code>.</p>
pub fn status(mut self, input: crate::types::AgreementStatusType) -> Self {
self.status = ::std::option::Option::Some(input);
self
}
/// <p>The status of the agreement. The agreement can be either <code>ACTIVE</code> or <code>INACTIVE</code>.</p>
pub fn set_status(mut self, input: ::std::option::Option<crate::types::AgreementStatusType>) -> Self {
self.status = input;
self
}
/// <p>The status of the agreement. The agreement can be either <code>ACTIVE</code> or <code>INACTIVE</code>.</p>
pub fn get_status(&self) -> &::std::option::Option<crate::types::AgreementStatusType> {
&self.status
}
/// Appends an item to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>Key-value pairs that can be used to group and search for agreements.</p>
pub fn tags(mut self, input: crate::types::Tag) -> Self {
let mut v = self.tags.unwrap_or_default();
v.push(input);
self.tags = ::std::option::Option::Some(v);
self
}
/// <p>Key-value pairs that can be used to group and search for agreements.</p>
pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
self.tags = input;
self
}
/// <p>Key-value pairs that can be used to group and search for agreements.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
&self.tags
}
/// <p>Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.</p>
/// <ul>
/// <li>
/// <p><code>ENABLED</code>: the filename provided by your trading parter is preserved when the file is saved.</p></li>
/// <li>
/// <p><code>DISABLED</code> (default value): when Transfer Family saves the file, the filename is adjusted, as described in <a href="https://docs.aws.amazon.com/transfer/latest/userguide/send-as2-messages.html#file-names-as2">File names and locations</a>.</p></li>
/// </ul>
pub fn preserve_filename(mut self, input: crate::types::PreserveFilenameType) -> Self {
self.preserve_filename = ::std::option::Option::Some(input);
self
}
/// <p>Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.</p>
/// <ul>
/// <li>
/// <p><code>ENABLED</code>: the filename provided by your trading parter is preserved when the file is saved.</p></li>
/// <li>
/// <p><code>DISABLED</code> (default value): when Transfer Family saves the file, the filename is adjusted, as described in <a href="https://docs.aws.amazon.com/transfer/latest/userguide/send-as2-messages.html#file-names-as2">File names and locations</a>.</p></li>
/// </ul>
pub fn set_preserve_filename(mut self, input: ::std::option::Option<crate::types::PreserveFilenameType>) -> Self {
self.preserve_filename = input;
self
}
/// <p>Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.</p>
/// <ul>
/// <li>
/// <p><code>ENABLED</code>: the filename provided by your trading parter is preserved when the file is saved.</p></li>
/// <li>
/// <p><code>DISABLED</code> (default value): when Transfer Family saves the file, the filename is adjusted, as described in <a href="https://docs.aws.amazon.com/transfer/latest/userguide/send-as2-messages.html#file-names-as2">File names and locations</a>.</p></li>
/// </ul>
pub fn get_preserve_filename(&self) -> &::std::option::Option<crate::types::PreserveFilenameType> {
&self.preserve_filename
}
/// <p>Determines whether or not unsigned messages from your trading partners will be accepted.</p>
/// <ul>
/// <li>
/// <p><code>ENABLED</code>: Transfer Family rejects unsigned messages from your trading partner.</p></li>
/// <li>
/// <p><code>DISABLED</code> (default value): Transfer Family accepts unsigned messages from your trading partner.</p></li>
/// </ul>
pub fn enforce_message_signing(mut self, input: crate::types::EnforceMessageSigningType) -> Self {
self.enforce_message_signing = ::std::option::Option::Some(input);
self
}
/// <p>Determines whether or not unsigned messages from your trading partners will be accepted.</p>
/// <ul>
/// <li>
/// <p><code>ENABLED</code>: Transfer Family rejects unsigned messages from your trading partner.</p></li>
/// <li>
/// <p><code>DISABLED</code> (default value): Transfer Family accepts unsigned messages from your trading partner.</p></li>
/// </ul>
pub fn set_enforce_message_signing(mut self, input: ::std::option::Option<crate::types::EnforceMessageSigningType>) -> Self {
self.enforce_message_signing = input;
self
}
/// <p>Determines whether or not unsigned messages from your trading partners will be accepted.</p>
/// <ul>
/// <li>
/// <p><code>ENABLED</code>: Transfer Family rejects unsigned messages from your trading partner.</p></li>
/// <li>
/// <p><code>DISABLED</code> (default value): Transfer Family accepts unsigned messages from your trading partner.</p></li>
/// </ul>
pub fn get_enforce_message_signing(&self) -> &::std::option::Option<crate::types::EnforceMessageSigningType> {
&self.enforce_message_signing
}
/// <p>A <code>CustomDirectoriesType</code> structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.</p>
/// <ul>
/// <li>
/// <p>Failed files</p></li>
/// <li>
/// <p>MDN files</p></li>
/// <li>
/// <p>Payload files</p></li>
/// <li>
/// <p>Status files</p></li>
/// <li>
/// <p>Temporary files</p></li>
/// </ul>
pub fn custom_directories(mut self, input: crate::types::CustomDirectoriesType) -> Self {
self.custom_directories = ::std::option::Option::Some(input);
self
}
/// <p>A <code>CustomDirectoriesType</code> structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.</p>
/// <ul>
/// <li>
/// <p>Failed files</p></li>
/// <li>
/// <p>MDN files</p></li>
/// <li>
/// <p>Payload files</p></li>
/// <li>
/// <p>Status files</p></li>
/// <li>
/// <p>Temporary files</p></li>
/// </ul>
pub fn set_custom_directories(mut self, input: ::std::option::Option<crate::types::CustomDirectoriesType>) -> Self {
self.custom_directories = input;
self
}
/// <p>A <code>CustomDirectoriesType</code> structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.</p>
/// <ul>
/// <li>
/// <p>Failed files</p></li>
/// <li>
/// <p>MDN files</p></li>
/// <li>
/// <p>Payload files</p></li>
/// <li>
/// <p>Status files</p></li>
/// <li>
/// <p>Temporary files</p></li>
/// </ul>
pub fn get_custom_directories(&self) -> &::std::option::Option<crate::types::CustomDirectoriesType> {
&self.custom_directories
}
/// Consumes the builder and constructs a [`CreateAgreementInput`](crate::operation::create_agreement::CreateAgreementInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::create_agreement::CreateAgreementInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::create_agreement::CreateAgreementInput {
description: self.description,
server_id: self.server_id,
local_profile_id: self.local_profile_id,
partner_profile_id: self.partner_profile_id,
base_directory: self.base_directory,
access_role: self.access_role,
status: self.status,
tags: self.tags,
preserve_filename: self.preserve_filename,
enforce_message_signing: self.enforce_message_signing,
custom_directories: self.custom_directories,
})
}
}