AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::ACMPCA::Model::RevokeCertificateRequest Class Reference

#include <RevokeCertificateRequest.h>

+ Inheritance diagram for Aws::ACMPCA::Model::RevokeCertificateRequest:

Public Member Functions

 RevokeCertificateRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetCertificateAuthorityArn () const
 
bool CertificateAuthorityArnHasBeenSet () const
 
void SetCertificateAuthorityArn (const Aws::String &value)
 
void SetCertificateAuthorityArn (Aws::String &&value)
 
void SetCertificateAuthorityArn (const char *value)
 
RevokeCertificateRequestWithCertificateAuthorityArn (const Aws::String &value)
 
RevokeCertificateRequestWithCertificateAuthorityArn (Aws::String &&value)
 
RevokeCertificateRequestWithCertificateAuthorityArn (const char *value)
 
const Aws::StringGetCertificateSerial () const
 
bool CertificateSerialHasBeenSet () const
 
void SetCertificateSerial (const Aws::String &value)
 
void SetCertificateSerial (Aws::String &&value)
 
void SetCertificateSerial (const char *value)
 
RevokeCertificateRequestWithCertificateSerial (const Aws::String &value)
 
RevokeCertificateRequestWithCertificateSerial (Aws::String &&value)
 
RevokeCertificateRequestWithCertificateSerial (const char *value)
 
const RevocationReasonGetRevocationReason () const
 
bool RevocationReasonHasBeenSet () const
 
void SetRevocationReason (const RevocationReason &value)
 
void SetRevocationReason (RevocationReason &&value)
 
RevokeCertificateRequestWithRevocationReason (const RevocationReason &value)
 
RevokeCertificateRequestWithRevocationReason (RevocationReason &&value)
 
- Public Member Functions inherited from Aws::ACMPCA::ACMPCARequest
virtual ~ACMPCARequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file RevokeCertificateRequest.h.

Constructor & Destructor Documentation

◆ RevokeCertificateRequest()

Aws::ACMPCA::Model::RevokeCertificateRequest::RevokeCertificateRequest ( )

Member Function Documentation

◆ CertificateAuthorityArnHasBeenSet()

bool Aws::ACMPCA::Model::RevokeCertificateRequest::CertificateAuthorityArnHasBeenSet ( ) const
inline

Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

Definition at line 52 of file RevokeCertificateRequest.h.

◆ CertificateSerialHasBeenSet()

bool Aws::ACMPCA::Model::RevokeCertificateRequest::CertificateSerialHasBeenSet ( ) const
inline

Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate 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.

openssl x509 -in file_path -text -noout

You can also copy the serial number from the console or use the DescribeCertificate action in the AWS Certificate Manager API Reference.

Definition at line 131 of file RevokeCertificateRequest.h.

◆ GetCertificateAuthorityArn()

const Aws::String& Aws::ACMPCA::Model::RevokeCertificateRequest::GetCertificateAuthorityArn ( ) const
inline

Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

Definition at line 44 of file RevokeCertificateRequest.h.

◆ GetCertificateSerial()

const Aws::String& Aws::ACMPCA::Model::RevokeCertificateRequest::GetCertificateSerial ( ) const
inline

Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate 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.

openssl x509 -in file_path -text -noout

You can also copy the serial number from the console or use the DescribeCertificate action in the AWS Certificate Manager API Reference.

Definition at line 116 of file RevokeCertificateRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::ACMPCA::Model::RevokeCertificateRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::ACMPCA::ACMPCARequest.

◆ GetRevocationReason()

const RevocationReason& Aws::ACMPCA::Model::RevokeCertificateRequest::GetRevocationReason ( ) const
inline

Specifies why you revoked the certificate.

Definition at line 227 of file RevokeCertificateRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::ACMPCA::Model::RevokeCertificateRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file RevokeCertificateRequest.h.

◆ RevocationReasonHasBeenSet()

bool Aws::ACMPCA::Model::RevokeCertificateRequest::RevocationReasonHasBeenSet ( ) const
inline

Specifies why you revoked the certificate.

Definition at line 232 of file RevokeCertificateRequest.h.

◆ SerializePayload()

Aws::String Aws::ACMPCA::Model::RevokeCertificateRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCertificateAuthorityArn() [1/3]

void Aws::ACMPCA::Model::RevokeCertificateRequest::SetCertificateAuthorityArn ( const Aws::String value)
inline

Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

Definition at line 60 of file RevokeCertificateRequest.h.

◆ SetCertificateAuthorityArn() [2/3]

void Aws::ACMPCA::Model::RevokeCertificateRequest::SetCertificateAuthorityArn ( Aws::String &&  value)
inline

Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

Definition at line 68 of file RevokeCertificateRequest.h.

◆ SetCertificateAuthorityArn() [3/3]

void Aws::ACMPCA::Model::RevokeCertificateRequest::SetCertificateAuthorityArn ( const char *  value)
inline

Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

Definition at line 76 of file RevokeCertificateRequest.h.

◆ SetCertificateSerial() [1/3]

void Aws::ACMPCA::Model::RevokeCertificateRequest::SetCertificateSerial ( const Aws::String value)
inline

Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate 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.

openssl x509 -in file_path -text -noout

You can also copy the serial number from the console or use the DescribeCertificate action in the AWS Certificate Manager API Reference.

Definition at line 146 of file RevokeCertificateRequest.h.

◆ SetCertificateSerial() [2/3]

void Aws::ACMPCA::Model::RevokeCertificateRequest::SetCertificateSerial ( Aws::String &&  value)
inline

Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate 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.

openssl x509 -in file_path -text -noout

You can also copy the serial number from the console or use the DescribeCertificate action in the AWS Certificate Manager API Reference.

Definition at line 161 of file RevokeCertificateRequest.h.

◆ SetCertificateSerial() [3/3]

void Aws::ACMPCA::Model::RevokeCertificateRequest::SetCertificateSerial ( const char *  value)
inline

Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate 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.

openssl x509 -in file_path -text -noout

You can also copy the serial number from the console or use the DescribeCertificate action in the AWS Certificate Manager API Reference.

Definition at line 176 of file RevokeCertificateRequest.h.

◆ SetRevocationReason() [1/2]

void Aws::ACMPCA::Model::RevokeCertificateRequest::SetRevocationReason ( const RevocationReason value)
inline

Specifies why you revoked the certificate.

Definition at line 237 of file RevokeCertificateRequest.h.

◆ SetRevocationReason() [2/2]

void Aws::ACMPCA::Model::RevokeCertificateRequest::SetRevocationReason ( RevocationReason &&  value)
inline

Specifies why you revoked the certificate.

Definition at line 242 of file RevokeCertificateRequest.h.

◆ WithCertificateAuthorityArn() [1/3]

RevokeCertificateRequest& Aws::ACMPCA::Model::RevokeCertificateRequest::WithCertificateAuthorityArn ( const Aws::String value)
inline

Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

Definition at line 84 of file RevokeCertificateRequest.h.

◆ WithCertificateAuthorityArn() [2/3]

RevokeCertificateRequest& Aws::ACMPCA::Model::RevokeCertificateRequest::WithCertificateAuthorityArn ( Aws::String &&  value)
inline

Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

Definition at line 92 of file RevokeCertificateRequest.h.

◆ WithCertificateAuthorityArn() [3/3]

RevokeCertificateRequest& Aws::ACMPCA::Model::RevokeCertificateRequest::WithCertificateAuthorityArn ( const char *  value)
inline

Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

Definition at line 100 of file RevokeCertificateRequest.h.

◆ WithCertificateSerial() [1/3]

RevokeCertificateRequest& Aws::ACMPCA::Model::RevokeCertificateRequest::WithCertificateSerial ( const Aws::String value)
inline

Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate 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.

openssl x509 -in file_path -text -noout

You can also copy the serial number from the console or use the DescribeCertificate action in the AWS Certificate Manager API Reference.

Definition at line 191 of file RevokeCertificateRequest.h.

◆ WithCertificateSerial() [2/3]

RevokeCertificateRequest& Aws::ACMPCA::Model::RevokeCertificateRequest::WithCertificateSerial ( Aws::String &&  value)
inline

Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate 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.

openssl x509 -in file_path -text -noout

You can also copy the serial number from the console or use the DescribeCertificate action in the AWS Certificate Manager API Reference.

Definition at line 206 of file RevokeCertificateRequest.h.

◆ WithCertificateSerial() [3/3]

RevokeCertificateRequest& Aws::ACMPCA::Model::RevokeCertificateRequest::WithCertificateSerial ( const char *  value)
inline

Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate 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.

openssl x509 -in file_path -text -noout

You can also copy the serial number from the console or use the DescribeCertificate action in the AWS Certificate Manager API Reference.

Definition at line 221 of file RevokeCertificateRequest.h.

◆ WithRevocationReason() [1/2]

RevokeCertificateRequest& Aws::ACMPCA::Model::RevokeCertificateRequest::WithRevocationReason ( const RevocationReason value)
inline

Specifies why you revoked the certificate.

Definition at line 247 of file RevokeCertificateRequest.h.

◆ WithRevocationReason() [2/2]

RevokeCertificateRequest& Aws::ACMPCA::Model::RevokeCertificateRequest::WithRevocationReason ( RevocationReason &&  value)
inline

Specifies why you revoked the certificate.

Definition at line 252 of file RevokeCertificateRequest.h.


The documentation for this class was generated from the following file: