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

#include <IssueCertificateRequest.h>

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

Public Member Functions

 IssueCertificateRequest ()
 
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)
 
IssueCertificateRequestWithCertificateAuthorityArn (const Aws::String &value)
 
IssueCertificateRequestWithCertificateAuthorityArn (Aws::String &&value)
 
IssueCertificateRequestWithCertificateAuthorityArn (const char *value)
 
const Aws::Utils::ByteBufferGetCsr () const
 
bool CsrHasBeenSet () const
 
void SetCsr (const Aws::Utils::ByteBuffer &value)
 
void SetCsr (Aws::Utils::ByteBuffer &&value)
 
IssueCertificateRequestWithCsr (const Aws::Utils::ByteBuffer &value)
 
IssueCertificateRequestWithCsr (Aws::Utils::ByteBuffer &&value)
 
const SigningAlgorithmGetSigningAlgorithm () const
 
bool SigningAlgorithmHasBeenSet () const
 
void SetSigningAlgorithm (const SigningAlgorithm &value)
 
void SetSigningAlgorithm (SigningAlgorithm &&value)
 
IssueCertificateRequestWithSigningAlgorithm (const SigningAlgorithm &value)
 
IssueCertificateRequestWithSigningAlgorithm (SigningAlgorithm &&value)
 
const Aws::StringGetTemplateArn () const
 
bool TemplateArnHasBeenSet () const
 
void SetTemplateArn (const Aws::String &value)
 
void SetTemplateArn (Aws::String &&value)
 
void SetTemplateArn (const char *value)
 
IssueCertificateRequestWithTemplateArn (const Aws::String &value)
 
IssueCertificateRequestWithTemplateArn (Aws::String &&value)
 
IssueCertificateRequestWithTemplateArn (const char *value)
 
const ValidityGetValidity () const
 
bool ValidityHasBeenSet () const
 
void SetValidity (const Validity &value)
 
void SetValidity (Validity &&value)
 
IssueCertificateRequestWithValidity (const Validity &value)
 
IssueCertificateRequestWithValidity (Validity &&value)
 
const Aws::StringGetIdempotencyToken () const
 
bool IdempotencyTokenHasBeenSet () const
 
void SetIdempotencyToken (const Aws::String &value)
 
void SetIdempotencyToken (Aws::String &&value)
 
void SetIdempotencyToken (const char *value)
 
IssueCertificateRequestWithIdempotencyToken (const Aws::String &value)
 
IssueCertificateRequestWithIdempotencyToken (Aws::String &&value)
 
IssueCertificateRequestWithIdempotencyToken (const char *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 24 of file IssueCertificateRequest.h.

Constructor & Destructor Documentation

◆ IssueCertificateRequest()

Aws::ACMPCA::Model::IssueCertificateRequest::IssueCertificateRequest ( )

Member Function Documentation

◆ CertificateAuthorityArnHasBeenSet()

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

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

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

Definition at line 56 of file IssueCertificateRequest.h.

◆ CsrHasBeenSet()

bool Aws::ACMPCA::Model::IssueCertificateRequest::CsrHasBeenSet ( ) const
inline

The certificate signing request (CSR) for the certificate you want to issue. You can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.

openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

If you have a configuration file, you can use the following OpenSSL command. The usr_cert block in the configuration file contains your X509 version 3 extensions.

openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

Note: A CSR must provide either a subject name or a subject alternative name or the request will be rejected.

Definition at line 141 of file IssueCertificateRequest.h.

◆ GetCertificateAuthorityArn()

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

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

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

Definition at line 47 of file IssueCertificateRequest.h.

◆ GetCsr()

const Aws::Utils::ByteBuffer& Aws::ACMPCA::Model::IssueCertificateRequest::GetCsr ( ) const
inline

The certificate signing request (CSR) for the certificate you want to issue. You can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.

openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

If you have a configuration file, you can use the following OpenSSL command. The usr_cert block in the configuration file contains your X509 version 3 extensions.

openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

Note: A CSR must provide either a subject name or a subject alternative name or the request will be rejected.

Definition at line 126 of file IssueCertificateRequest.h.

◆ GetIdempotencyToken()

const Aws::String& Aws::ACMPCA::Model::IssueCertificateRequest::GetIdempotencyToken ( ) const
inline

Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.

Definition at line 598 of file IssueCertificateRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::ACMPCA::ACMPCARequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file IssueCertificateRequest.h.

◆ GetSigningAlgorithm()

const SigningAlgorithm& Aws::ACMPCA::Model::IssueCertificateRequest::GetSigningAlgorithm ( ) const
inline

The name of the algorithm that will be used to sign the certificate to be issued.

This parameter should not be confused with the SigningAlgorithm parameter used to sign a CSR.

Definition at line 209 of file IssueCertificateRequest.h.

◆ GetTemplateArn()

const Aws::String& Aws::ACMPCA::Model::IssueCertificateRequest::GetTemplateArn ( ) const
inline

Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template. For CA certificates, you should choose the shortest path length that meets your needs. The path length is indicated by the PathLenN portion of the ARN, where N is the CA depth.

Note: The CA depth configured on a subordinate CA certificate must not exceed the limit set by its parents in the CA hierarchy.

The following service-owned TemplateArn values are supported by ACM Private CA:

  • arn:aws:acm-pca:::template/CodeSigningCertificate/V1

  • arn:aws:acm-pca:::template/CodeSigningCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityClientAuthCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityClientAuthCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityServerAuthCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityServerAuthCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/OCSPSigningCertificate/V1

  • arn:aws:acm-pca:::template/OCSPSigningCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/RootCACertificate/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1

For more information, see Using Templates.

Definition at line 280 of file IssueCertificateRequest.h.

◆ GetValidity()

const Validity& Aws::ACMPCA::Model::IssueCertificateRequest::GetValidity ( ) const
inline

Information describing the validity period of the certificate.

When issuing a certificate, ACM Private CA sets the "Not Before" date in the validity field to date and time minus 60 minutes. This is intended to compensate for time inconsistencies across systems of 60 minutes or less.

The validity period configured on a certificate must not exceed the limit set by its parents in the CA hierarchy.

Definition at line 536 of file IssueCertificateRequest.h.

◆ IdempotencyTokenHasBeenSet()

bool Aws::ACMPCA::Model::IssueCertificateRequest::IdempotencyTokenHasBeenSet ( ) const
inline

Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.

Definition at line 609 of file IssueCertificateRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCertificateAuthorityArn() [1/3]

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

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

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

Definition at line 65 of file IssueCertificateRequest.h.

◆ SetCertificateAuthorityArn() [2/3]

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

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

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

Definition at line 74 of file IssueCertificateRequest.h.

◆ SetCertificateAuthorityArn() [3/3]

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

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

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

Definition at line 83 of file IssueCertificateRequest.h.

◆ SetCsr() [1/2]

void Aws::ACMPCA::Model::IssueCertificateRequest::SetCsr ( const Aws::Utils::ByteBuffer value)
inline

The certificate signing request (CSR) for the certificate you want to issue. You can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.

openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

If you have a configuration file, you can use the following OpenSSL command. The usr_cert block in the configuration file contains your X509 version 3 extensions.

openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

Note: A CSR must provide either a subject name or a subject alternative name or the request will be rejected.

Definition at line 156 of file IssueCertificateRequest.h.

◆ SetCsr() [2/2]

void Aws::ACMPCA::Model::IssueCertificateRequest::SetCsr ( Aws::Utils::ByteBuffer &&  value)
inline

The certificate signing request (CSR) for the certificate you want to issue. You can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.

openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

If you have a configuration file, you can use the following OpenSSL command. The usr_cert block in the configuration file contains your X509 version 3 extensions.

openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

Note: A CSR must provide either a subject name or a subject alternative name or the request will be rejected.

Definition at line 171 of file IssueCertificateRequest.h.

◆ SetIdempotencyToken() [1/3]

void Aws::ACMPCA::Model::IssueCertificateRequest::SetIdempotencyToken ( const Aws::String value)
inline

Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.

Definition at line 620 of file IssueCertificateRequest.h.

◆ SetIdempotencyToken() [2/3]

void Aws::ACMPCA::Model::IssueCertificateRequest::SetIdempotencyToken ( Aws::String &&  value)
inline

Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.

Definition at line 631 of file IssueCertificateRequest.h.

◆ SetIdempotencyToken() [3/3]

void Aws::ACMPCA::Model::IssueCertificateRequest::SetIdempotencyToken ( const char *  value)
inline

Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.

Definition at line 642 of file IssueCertificateRequest.h.

◆ SetSigningAlgorithm() [1/2]

void Aws::ACMPCA::Model::IssueCertificateRequest::SetSigningAlgorithm ( const SigningAlgorithm value)
inline

The name of the algorithm that will be used to sign the certificate to be issued.

This parameter should not be confused with the SigningAlgorithm parameter used to sign a CSR.

Definition at line 223 of file IssueCertificateRequest.h.

◆ SetSigningAlgorithm() [2/2]

void Aws::ACMPCA::Model::IssueCertificateRequest::SetSigningAlgorithm ( SigningAlgorithm &&  value)
inline

The name of the algorithm that will be used to sign the certificate to be issued.

This parameter should not be confused with the SigningAlgorithm parameter used to sign a CSR.

Definition at line 230 of file IssueCertificateRequest.h.

◆ SetTemplateArn() [1/3]

void Aws::ACMPCA::Model::IssueCertificateRequest::SetTemplateArn ( const Aws::String value)
inline

Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template. For CA certificates, you should choose the shortest path length that meets your needs. The path length is indicated by the PathLenN portion of the ARN, where N is the CA depth.

Note: The CA depth configured on a subordinate CA certificate must not exceed the limit set by its parents in the CA hierarchy.

The following service-owned TemplateArn values are supported by ACM Private CA:

  • arn:aws:acm-pca:::template/CodeSigningCertificate/V1

  • arn:aws:acm-pca:::template/CodeSigningCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityClientAuthCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityClientAuthCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityServerAuthCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityServerAuthCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/OCSPSigningCertificate/V1

  • arn:aws:acm-pca:::template/OCSPSigningCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/RootCACertificate/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1

For more information, see Using Templates.

Definition at line 350 of file IssueCertificateRequest.h.

◆ SetTemplateArn() [2/3]

void Aws::ACMPCA::Model::IssueCertificateRequest::SetTemplateArn ( Aws::String &&  value)
inline

Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template. For CA certificates, you should choose the shortest path length that meets your needs. The path length is indicated by the PathLenN portion of the ARN, where N is the CA depth.

Note: The CA depth configured on a subordinate CA certificate must not exceed the limit set by its parents in the CA hierarchy.

The following service-owned TemplateArn values are supported by ACM Private CA:

  • arn:aws:acm-pca:::template/CodeSigningCertificate/V1

  • arn:aws:acm-pca:::template/CodeSigningCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityClientAuthCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityClientAuthCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityServerAuthCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityServerAuthCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/OCSPSigningCertificate/V1

  • arn:aws:acm-pca:::template/OCSPSigningCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/RootCACertificate/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1

For more information, see Using Templates.

Definition at line 385 of file IssueCertificateRequest.h.

◆ SetTemplateArn() [3/3]

void Aws::ACMPCA::Model::IssueCertificateRequest::SetTemplateArn ( const char *  value)
inline

Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template. For CA certificates, you should choose the shortest path length that meets your needs. The path length is indicated by the PathLenN portion of the ARN, where N is the CA depth.

Note: The CA depth configured on a subordinate CA certificate must not exceed the limit set by its parents in the CA hierarchy.

The following service-owned TemplateArn values are supported by ACM Private CA:

  • arn:aws:acm-pca:::template/CodeSigningCertificate/V1

  • arn:aws:acm-pca:::template/CodeSigningCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityClientAuthCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityClientAuthCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityServerAuthCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityServerAuthCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/OCSPSigningCertificate/V1

  • arn:aws:acm-pca:::template/OCSPSigningCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/RootCACertificate/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1

For more information, see Using Templates.

Definition at line 420 of file IssueCertificateRequest.h.

◆ SetValidity() [1/2]

void Aws::ACMPCA::Model::IssueCertificateRequest::SetValidity ( const Validity value)
inline

Information describing the validity period of the certificate.

When issuing a certificate, ACM Private CA sets the "Not Before" date in the validity field to date and time minus 60 minutes. This is intended to compensate for time inconsistencies across systems of 60 minutes or less.

The validity period configured on a certificate must not exceed the limit set by its parents in the CA hierarchy.

Definition at line 556 of file IssueCertificateRequest.h.

◆ SetValidity() [2/2]

void Aws::ACMPCA::Model::IssueCertificateRequest::SetValidity ( Validity &&  value)
inline

Information describing the validity period of the certificate.

When issuing a certificate, ACM Private CA sets the "Not Before" date in the validity field to date and time minus 60 minutes. This is intended to compensate for time inconsistencies across systems of 60 minutes or less.

The validity period configured on a certificate must not exceed the limit set by its parents in the CA hierarchy.

Definition at line 566 of file IssueCertificateRequest.h.

◆ SigningAlgorithmHasBeenSet()

bool Aws::ACMPCA::Model::IssueCertificateRequest::SigningAlgorithmHasBeenSet ( ) const
inline

The name of the algorithm that will be used to sign the certificate to be issued.

This parameter should not be confused with the SigningAlgorithm parameter used to sign a CSR.

Definition at line 216 of file IssueCertificateRequest.h.

◆ TemplateArnHasBeenSet()

bool Aws::ACMPCA::Model::IssueCertificateRequest::TemplateArnHasBeenSet ( ) const
inline

Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template. For CA certificates, you should choose the shortest path length that meets your needs. The path length is indicated by the PathLenN portion of the ARN, where N is the CA depth.

Note: The CA depth configured on a subordinate CA certificate must not exceed the limit set by its parents in the CA hierarchy.

The following service-owned TemplateArn values are supported by ACM Private CA:

  • arn:aws:acm-pca:::template/CodeSigningCertificate/V1

  • arn:aws:acm-pca:::template/CodeSigningCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityClientAuthCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityClientAuthCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityServerAuthCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityServerAuthCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/OCSPSigningCertificate/V1

  • arn:aws:acm-pca:::template/OCSPSigningCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/RootCACertificate/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1

For more information, see Using Templates.

Definition at line 315 of file IssueCertificateRequest.h.

◆ ValidityHasBeenSet()

bool Aws::ACMPCA::Model::IssueCertificateRequest::ValidityHasBeenSet ( ) const
inline

Information describing the validity period of the certificate.

When issuing a certificate, ACM Private CA sets the "Not Before" date in the validity field to date and time minus 60 minutes. This is intended to compensate for time inconsistencies across systems of 60 minutes or less.

The validity period configured on a certificate must not exceed the limit set by its parents in the CA hierarchy.

Definition at line 546 of file IssueCertificateRequest.h.

◆ WithCertificateAuthorityArn() [1/3]

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

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. 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 IssueCertificateRequest.h.

◆ WithCertificateAuthorityArn() [2/3]

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

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

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

Definition at line 101 of file IssueCertificateRequest.h.

◆ WithCertificateAuthorityArn() [3/3]

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

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

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

Definition at line 110 of file IssueCertificateRequest.h.

◆ WithCsr() [1/2]

IssueCertificateRequest& Aws::ACMPCA::Model::IssueCertificateRequest::WithCsr ( const Aws::Utils::ByteBuffer value)
inline

The certificate signing request (CSR) for the certificate you want to issue. You can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.

openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

If you have a configuration file, you can use the following OpenSSL command. The usr_cert block in the configuration file contains your X509 version 3 extensions.

openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

Note: A CSR must provide either a subject name or a subject alternative name or the request will be rejected.

Definition at line 186 of file IssueCertificateRequest.h.

◆ WithCsr() [2/2]

IssueCertificateRequest& Aws::ACMPCA::Model::IssueCertificateRequest::WithCsr ( Aws::Utils::ByteBuffer &&  value)
inline

The certificate signing request (CSR) for the certificate you want to issue. You can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.

openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

If you have a configuration file, you can use the following OpenSSL command. The usr_cert block in the configuration file contains your X509 version 3 extensions.

openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

Note: A CSR must provide either a subject name or a subject alternative name or the request will be rejected.

Definition at line 201 of file IssueCertificateRequest.h.

◆ WithIdempotencyToken() [1/3]

IssueCertificateRequest& Aws::ACMPCA::Model::IssueCertificateRequest::WithIdempotencyToken ( const Aws::String value)
inline

Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.

Definition at line 653 of file IssueCertificateRequest.h.

◆ WithIdempotencyToken() [2/3]

IssueCertificateRequest& Aws::ACMPCA::Model::IssueCertificateRequest::WithIdempotencyToken ( Aws::String &&  value)
inline

Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.

Definition at line 664 of file IssueCertificateRequest.h.

◆ WithIdempotencyToken() [3/3]

IssueCertificateRequest& Aws::ACMPCA::Model::IssueCertificateRequest::WithIdempotencyToken ( const char *  value)
inline

Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.

Definition at line 675 of file IssueCertificateRequest.h.

◆ WithSigningAlgorithm() [1/2]

IssueCertificateRequest& Aws::ACMPCA::Model::IssueCertificateRequest::WithSigningAlgorithm ( const SigningAlgorithm value)
inline

The name of the algorithm that will be used to sign the certificate to be issued.

This parameter should not be confused with the SigningAlgorithm parameter used to sign a CSR.

Definition at line 237 of file IssueCertificateRequest.h.

◆ WithSigningAlgorithm() [2/2]

IssueCertificateRequest& Aws::ACMPCA::Model::IssueCertificateRequest::WithSigningAlgorithm ( SigningAlgorithm &&  value)
inline

The name of the algorithm that will be used to sign the certificate to be issued.

This parameter should not be confused with the SigningAlgorithm parameter used to sign a CSR.

Definition at line 244 of file IssueCertificateRequest.h.

◆ WithTemplateArn() [1/3]

IssueCertificateRequest& Aws::ACMPCA::Model::IssueCertificateRequest::WithTemplateArn ( const Aws::String value)
inline

Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template. For CA certificates, you should choose the shortest path length that meets your needs. The path length is indicated by the PathLenN portion of the ARN, where N is the CA depth.

Note: The CA depth configured on a subordinate CA certificate must not exceed the limit set by its parents in the CA hierarchy.

The following service-owned TemplateArn values are supported by ACM Private CA:

  • arn:aws:acm-pca:::template/CodeSigningCertificate/V1

  • arn:aws:acm-pca:::template/CodeSigningCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityClientAuthCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityClientAuthCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityServerAuthCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityServerAuthCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/OCSPSigningCertificate/V1

  • arn:aws:acm-pca:::template/OCSPSigningCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/RootCACertificate/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1

For more information, see Using Templates.

Definition at line 455 of file IssueCertificateRequest.h.

◆ WithTemplateArn() [2/3]

IssueCertificateRequest& Aws::ACMPCA::Model::IssueCertificateRequest::WithTemplateArn ( Aws::String &&  value)
inline

Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template. For CA certificates, you should choose the shortest path length that meets your needs. The path length is indicated by the PathLenN portion of the ARN, where N is the CA depth.

Note: The CA depth configured on a subordinate CA certificate must not exceed the limit set by its parents in the CA hierarchy.

The following service-owned TemplateArn values are supported by ACM Private CA:

  • arn:aws:acm-pca:::template/CodeSigningCertificate/V1

  • arn:aws:acm-pca:::template/CodeSigningCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityClientAuthCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityClientAuthCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityServerAuthCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityServerAuthCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/OCSPSigningCertificate/V1

  • arn:aws:acm-pca:::template/OCSPSigningCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/RootCACertificate/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1

For more information, see Using Templates.

Definition at line 490 of file IssueCertificateRequest.h.

◆ WithTemplateArn() [3/3]

IssueCertificateRequest& Aws::ACMPCA::Model::IssueCertificateRequest::WithTemplateArn ( const char *  value)
inline

Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template. For CA certificates, you should choose the shortest path length that meets your needs. The path length is indicated by the PathLenN portion of the ARN, where N is the CA depth.

Note: The CA depth configured on a subordinate CA certificate must not exceed the limit set by its parents in the CA hierarchy.

The following service-owned TemplateArn values are supported by ACM Private CA:

  • arn:aws:acm-pca:::template/CodeSigningCertificate/V1

  • arn:aws:acm-pca:::template/CodeSigningCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityClientAuthCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityClientAuthCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/EndEntityServerAuthCertificate/V1

  • arn:aws:acm-pca:::template/EndEntityServerAuthCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/OCSPSigningCertificate/V1

  • arn:aws:acm-pca:::template/OCSPSigningCertificate_CSRPassthrough/V1

  • arn:aws:acm-pca:::template/RootCACertificate/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1

For more information, see Using Templates.

Definition at line 525 of file IssueCertificateRequest.h.

◆ WithValidity() [1/2]

IssueCertificateRequest& Aws::ACMPCA::Model::IssueCertificateRequest::WithValidity ( const Validity value)
inline

Information describing the validity period of the certificate.

When issuing a certificate, ACM Private CA sets the "Not Before" date in the validity field to date and time minus 60 minutes. This is intended to compensate for time inconsistencies across systems of 60 minutes or less.

The validity period configured on a certificate must not exceed the limit set by its parents in the CA hierarchy.

Definition at line 576 of file IssueCertificateRequest.h.

◆ WithValidity() [2/2]

IssueCertificateRequest& Aws::ACMPCA::Model::IssueCertificateRequest::WithValidity ( Validity &&  value)
inline

Information describing the validity period of the certificate.

When issuing a certificate, ACM Private CA sets the "Not Before" date in the validity field to date and time minus 60 minutes. This is intended to compensate for time inconsistencies across systems of 60 minutes or less.

The validity period configured on a certificate must not exceed the limit set by its parents in the CA hierarchy.

Definition at line 586 of file IssueCertificateRequest.h.


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