// 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 RevokeCertificateInput {
/// <p>Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:</p>
/// <p><code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code></p>
pub certificate_authority_arn: ::std::option::Option<::std::string::String>,
/// <p>Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html">GetCertificate</a> with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The <b>GetCertificate</b> action retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number.</p>
/// <p><code>openssl x509 -in <i>file_path</i> -text -noout</code></p>
/// <p>You can also copy the serial number from the console or use the <a href="https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html">DescribeCertificate</a> action in the <i>Certificate Manager API Reference</i>.</p>
pub certificate_serial: ::std::option::Option<::std::string::String>,
/// <p>Specifies why you revoked the certificate.</p>
pub revocation_reason: ::std::option::Option<crate::types::RevocationReason>,
}
impl RevokeCertificateInput {
/// <p>Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:</p>
/// <p><code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code></p>
pub fn certificate_authority_arn(&self) -> ::std::option::Option<&str> {
self.certificate_authority_arn.as_deref()
}
/// <p>Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html">GetCertificate</a> with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The <b>GetCertificate</b> action retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number.</p>
/// <p><code>openssl x509 -in <i>file_path</i> -text -noout</code></p>
/// <p>You can also copy the serial number from the console or use the <a href="https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html">DescribeCertificate</a> action in the <i>Certificate Manager API Reference</i>.</p>
pub fn certificate_serial(&self) -> ::std::option::Option<&str> {
self.certificate_serial.as_deref()
}
/// <p>Specifies why you revoked the certificate.</p>
pub fn revocation_reason(&self) -> ::std::option::Option<&crate::types::RevocationReason> {
self.revocation_reason.as_ref()
}
}
impl RevokeCertificateInput {
/// Creates a new builder-style object to manufacture [`RevokeCertificateInput`](crate::operation::revoke_certificate::RevokeCertificateInput).
pub fn builder() -> crate::operation::revoke_certificate::builders::RevokeCertificateInputBuilder {
crate::operation::revoke_certificate::builders::RevokeCertificateInputBuilder::default()
}
}
/// A builder for [`RevokeCertificateInput`](crate::operation::revoke_certificate::RevokeCertificateInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct RevokeCertificateInputBuilder {
pub(crate) certificate_authority_arn: ::std::option::Option<::std::string::String>,
pub(crate) certificate_serial: ::std::option::Option<::std::string::String>,
pub(crate) revocation_reason: ::std::option::Option<crate::types::RevocationReason>,
}
impl RevokeCertificateInputBuilder {
/// <p>Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:</p>
/// <p><code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code></p>
/// This field is required.
pub fn certificate_authority_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.certificate_authority_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:</p>
/// <p><code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code></p>
pub fn set_certificate_authority_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.certificate_authority_arn = input;
self
}
/// <p>Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:</p>
/// <p><code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code></p>
pub fn get_certificate_authority_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.certificate_authority_arn
}
/// <p>Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html">GetCertificate</a> with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The <b>GetCertificate</b> action retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number.</p>
/// <p><code>openssl x509 -in <i>file_path</i> -text -noout</code></p>
/// <p>You can also copy the serial number from the console or use the <a href="https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html">DescribeCertificate</a> action in the <i>Certificate Manager API Reference</i>.</p>
/// This field is required.
pub fn certificate_serial(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.certificate_serial = ::std::option::Option::Some(input.into());
self
}
/// <p>Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html">GetCertificate</a> with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The <b>GetCertificate</b> action retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number.</p>
/// <p><code>openssl x509 -in <i>file_path</i> -text -noout</code></p>
/// <p>You can also copy the serial number from the console or use the <a href="https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html">DescribeCertificate</a> action in the <i>Certificate Manager API Reference</i>.</p>
pub fn set_certificate_serial(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.certificate_serial = input;
self
}
/// <p>Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html">GetCertificate</a> with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The <b>GetCertificate</b> action retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number.</p>
/// <p><code>openssl x509 -in <i>file_path</i> -text -noout</code></p>
/// <p>You can also copy the serial number from the console or use the <a href="https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html">DescribeCertificate</a> action in the <i>Certificate Manager API Reference</i>.</p>
pub fn get_certificate_serial(&self) -> &::std::option::Option<::std::string::String> {
&self.certificate_serial
}
/// <p>Specifies why you revoked the certificate.</p>
/// This field is required.
pub fn revocation_reason(mut self, input: crate::types::RevocationReason) -> Self {
self.revocation_reason = ::std::option::Option::Some(input);
self
}
/// <p>Specifies why you revoked the certificate.</p>
pub fn set_revocation_reason(mut self, input: ::std::option::Option<crate::types::RevocationReason>) -> Self {
self.revocation_reason = input;
self
}
/// <p>Specifies why you revoked the certificate.</p>
pub fn get_revocation_reason(&self) -> &::std::option::Option<crate::types::RevocationReason> {
&self.revocation_reason
}
/// Consumes the builder and constructs a [`RevokeCertificateInput`](crate::operation::revoke_certificate::RevokeCertificateInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::revoke_certificate::RevokeCertificateInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::revoke_certificate::RevokeCertificateInput {
certificate_authority_arn: self.certificate_authority_arn,
certificate_serial: self.certificate_serial,
revocation_reason: self.revocation_reason,
})
}
}