aws_sdk_transfer/client/import_certificate.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`ImportCertificate`](crate::operation::import_certificate::builders::ImportCertificateFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`usage(CertificateUsageType)`](crate::operation::import_certificate::builders::ImportCertificateFluentBuilder::usage) / [`set_usage(Option<CertificateUsageType>)`](crate::operation::import_certificate::builders::ImportCertificateFluentBuilder::set_usage):<br>required: **true**<br><p>Specifies how this certificate is used. It can be used in the following ways:</p> <ul> <li> <p><code>SIGNING</code>: For signing AS2 messages</p></li> <li> <p><code>ENCRYPTION</code>: For encrypting AS2 messages</p></li> <li> <p><code>TLS</code>: For securing AS2 communications sent over HTTPS</p></li> </ul><br>
7 /// - [`certificate(impl Into<String>)`](crate::operation::import_certificate::builders::ImportCertificateFluentBuilder::certificate) / [`set_certificate(Option<String>)`](crate::operation::import_certificate::builders::ImportCertificateFluentBuilder::set_certificate):<br>required: **true**<br><ul> <li> <p>For the CLI, provide a file path for a certificate in URI format. For example, <code>--certificate file://encryption-cert.pem</code>. Alternatively, you can provide the raw content.</p></li> <li> <p>For the SDK, specify the raw content of a certificate file. For example, <code>--certificate "`cat encryption-cert.pem`"</code>.</p></li> </ul><note> <p>You can provide both the certificate and its chain in this parameter, without needing to use the <code>CertificateChain</code> parameter. If you use this parameter for both the certificate and its chain, do not use the <code>CertificateChain</code> parameter.</p> </note><br>
8 /// - [`certificate_chain(impl Into<String>)`](crate::operation::import_certificate::builders::ImportCertificateFluentBuilder::certificate_chain) / [`set_certificate_chain(Option<String>)`](crate::operation::import_certificate::builders::ImportCertificateFluentBuilder::set_certificate_chain):<br>required: **false**<br><p>An optional list of certificates that make up the chain for the certificate that's being imported.</p><br>
9 /// - [`private_key(impl Into<String>)`](crate::operation::import_certificate::builders::ImportCertificateFluentBuilder::private_key) / [`set_private_key(Option<String>)`](crate::operation::import_certificate::builders::ImportCertificateFluentBuilder::set_private_key):<br>required: **false**<br><ul> <li> <p>For the CLI, provide a file path for a private key in URI format. For example, <code>--private-key file://encryption-key.pem</code>. Alternatively, you can provide the raw content of the private key file.</p></li> <li> <p>For the SDK, specify the raw content of a private key file. For example, <code>--private-key "`cat encryption-key.pem`"</code></p></li> </ul><br>
10 /// - [`active_date(DateTime)`](crate::operation::import_certificate::builders::ImportCertificateFluentBuilder::active_date) / [`set_active_date(Option<DateTime>)`](crate::operation::import_certificate::builders::ImportCertificateFluentBuilder::set_active_date):<br>required: **false**<br><p>An optional date that specifies when the certificate becomes active. If you do not specify a value, <code>ActiveDate</code> takes the same value as <code>NotBeforeDate</code>, which is specified by the CA.</p><br>
11 /// - [`inactive_date(DateTime)`](crate::operation::import_certificate::builders::ImportCertificateFluentBuilder::inactive_date) / [`set_inactive_date(Option<DateTime>)`](crate::operation::import_certificate::builders::ImportCertificateFluentBuilder::set_inactive_date):<br>required: **false**<br><p>An optional date that specifies when the certificate becomes inactive. If you do not specify a value, <code>InactiveDate</code> takes the same value as <code>NotAfterDate</code>, which is specified by the CA.</p><br>
12 /// - [`description(impl Into<String>)`](crate::operation::import_certificate::builders::ImportCertificateFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::import_certificate::builders::ImportCertificateFluentBuilder::set_description):<br>required: **false**<br><p>A short description that helps identify the certificate.</p><br>
13 /// - [`tags(Tag)`](crate::operation::import_certificate::builders::ImportCertificateFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::import_certificate::builders::ImportCertificateFluentBuilder::set_tags):<br>required: **false**<br><p>Key-value pairs that can be used to group and search for certificates.</p><br>
14 /// - On success, responds with [`ImportCertificateOutput`](crate::operation::import_certificate::ImportCertificateOutput) with field(s):
15 /// - [`certificate_id(String)`](crate::operation::import_certificate::ImportCertificateOutput::certificate_id): <p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>
16 /// - On failure, responds with [`SdkError<ImportCertificateError>`](crate::operation::import_certificate::ImportCertificateError)
17 pub fn import_certificate(&self) -> crate::operation::import_certificate::builders::ImportCertificateFluentBuilder {
18 crate::operation::import_certificate::builders::ImportCertificateFluentBuilder::new(self.handle.clone())
19 }
20}