aws-sdk-transfer 1.113.0

AWS SDK for AWS Transfer Family
Documentation
// 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)]
pub struct ImportCertificateInput {
    /// <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>
    pub usage: ::std::option::Option<crate::types::CertificateUsageType>,
    /// <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>
    pub certificate: ::std::option::Option<::std::string::String>,
    /// <p>An optional list of certificates that make up the chain for the certificate that's being imported.</p>
    pub certificate_chain: ::std::option::Option<::std::string::String>,
    /// <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>
    pub private_key: ::std::option::Option<::std::string::String>,
    /// <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>
    pub active_date: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <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>
    pub inactive_date: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>A short description that helps identify the certificate.</p>
    pub description: ::std::option::Option<::std::string::String>,
    /// <p>Key-value pairs that can be used to group and search for certificates.</p>
    pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl ImportCertificateInput {
    /// <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>
    pub fn usage(&self) -> ::std::option::Option<&crate::types::CertificateUsageType> {
        self.usage.as_ref()
    }
    /// <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>
    pub fn certificate(&self) -> ::std::option::Option<&str> {
        self.certificate.as_deref()
    }
    /// <p>An optional list of certificates that make up the chain for the certificate that's being imported.</p>
    pub fn certificate_chain(&self) -> ::std::option::Option<&str> {
        self.certificate_chain.as_deref()
    }
    /// <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>
    pub fn private_key(&self) -> ::std::option::Option<&str> {
        self.private_key.as_deref()
    }
    /// <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>
    pub fn active_date(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.active_date.as_ref()
    }
    /// <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>
    pub fn inactive_date(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.inactive_date.as_ref()
    }
    /// <p>A short description that helps identify the certificate.</p>
    pub fn description(&self) -> ::std::option::Option<&str> {
        self.description.as_deref()
    }
    /// <p>Key-value pairs that can be used to group and search for certificates.</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()
    }
}
impl ::std::fmt::Debug for ImportCertificateInput {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("ImportCertificateInput");
        formatter.field("usage", &self.usage);
        formatter.field("certificate", &"*** Sensitive Data Redacted ***");
        formatter.field("certificate_chain", &"*** Sensitive Data Redacted ***");
        formatter.field("private_key", &"*** Sensitive Data Redacted ***");
        formatter.field("active_date", &self.active_date);
        formatter.field("inactive_date", &self.inactive_date);
        formatter.field("description", &self.description);
        formatter.field("tags", &self.tags);
        formatter.finish()
    }
}
impl ImportCertificateInput {
    /// Creates a new builder-style object to manufacture [`ImportCertificateInput`](crate::operation::import_certificate::ImportCertificateInput).
    pub fn builder() -> crate::operation::import_certificate::builders::ImportCertificateInputBuilder {
        crate::operation::import_certificate::builders::ImportCertificateInputBuilder::default()
    }
}

/// A builder for [`ImportCertificateInput`](crate::operation::import_certificate::ImportCertificateInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct ImportCertificateInputBuilder {
    pub(crate) usage: ::std::option::Option<crate::types::CertificateUsageType>,
    pub(crate) certificate: ::std::option::Option<::std::string::String>,
    pub(crate) certificate_chain: ::std::option::Option<::std::string::String>,
    pub(crate) private_key: ::std::option::Option<::std::string::String>,
    pub(crate) active_date: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) inactive_date: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) description: ::std::option::Option<::std::string::String>,
    pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl ImportCertificateInputBuilder {
    /// <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>
    /// This field is required.
    pub fn usage(mut self, input: crate::types::CertificateUsageType) -> Self {
        self.usage = ::std::option::Option::Some(input);
        self
    }
    /// <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>
    pub fn set_usage(mut self, input: ::std::option::Option<crate::types::CertificateUsageType>) -> Self {
        self.usage = input;
        self
    }
    /// <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>
    pub fn get_usage(&self) -> &::std::option::Option<crate::types::CertificateUsageType> {
        &self.usage
    }
    /// <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>
    /// This field is required.
    pub fn certificate(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.certificate = ::std::option::Option::Some(input.into());
        self
    }
    /// <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>
    pub fn set_certificate(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.certificate = input;
        self
    }
    /// <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>
    pub fn get_certificate(&self) -> &::std::option::Option<::std::string::String> {
        &self.certificate
    }
    /// <p>An optional list of certificates that make up the chain for the certificate that's being imported.</p>
    pub fn certificate_chain(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.certificate_chain = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>An optional list of certificates that make up the chain for the certificate that's being imported.</p>
    pub fn set_certificate_chain(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.certificate_chain = input;
        self
    }
    /// <p>An optional list of certificates that make up the chain for the certificate that's being imported.</p>
    pub fn get_certificate_chain(&self) -> &::std::option::Option<::std::string::String> {
        &self.certificate_chain
    }
    /// <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>
    pub fn private_key(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.private_key = ::std::option::Option::Some(input.into());
        self
    }
    /// <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>
    pub fn set_private_key(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.private_key = input;
        self
    }
    /// <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>
    pub fn get_private_key(&self) -> &::std::option::Option<::std::string::String> {
        &self.private_key
    }
    /// <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>
    pub fn active_date(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.active_date = ::std::option::Option::Some(input);
        self
    }
    /// <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>
    pub fn set_active_date(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.active_date = input;
        self
    }
    /// <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>
    pub fn get_active_date(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.active_date
    }
    /// <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>
    pub fn inactive_date(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.inactive_date = ::std::option::Option::Some(input);
        self
    }
    /// <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>
    pub fn set_inactive_date(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.inactive_date = input;
        self
    }
    /// <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>
    pub fn get_inactive_date(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.inactive_date
    }
    /// <p>A short description that helps identify the certificate.</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 short description that helps identify the certificate.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.description = input;
        self
    }
    /// <p>A short description that helps identify the certificate.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.description
    }
    /// 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 certificates.</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 certificates.</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 certificates.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
        &self.tags
    }
    /// Consumes the builder and constructs a [`ImportCertificateInput`](crate::operation::import_certificate::ImportCertificateInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::import_certificate::ImportCertificateInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::import_certificate::ImportCertificateInput {
            usage: self.usage,
            certificate: self.certificate,
            certificate_chain: self.certificate_chain,
            private_key: self.private_key,
            active_date: self.active_date,
            inactive_date: self.inactive_date,
            description: self.description,
            tags: self.tags,
        })
    }
}
impl ::std::fmt::Debug for ImportCertificateInputBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("ImportCertificateInputBuilder");
        formatter.field("usage", &self.usage);
        formatter.field("certificate", &"*** Sensitive Data Redacted ***");
        formatter.field("certificate_chain", &"*** Sensitive Data Redacted ***");
        formatter.field("private_key", &"*** Sensitive Data Redacted ***");
        formatter.field("active_date", &self.active_date);
        formatter.field("inactive_date", &self.inactive_date);
        formatter.field("description", &self.description);
        formatter.field("tags", &self.tags);
        formatter.finish()
    }
}