Package software.amazon.awssdk.services.acmpca.model

Interface IssueCertificateRequest.Builder

    • Method Detail

      • apiPassthrough

        IssueCertificateRequest.Builder apiPassthrough​(ApiPassthrough apiPassthrough)

        Specifies X.509 certificate information to be included in the issued certificate. An APIPassthrough or APICSRPassthrough template variant must be selected, or else this parameter is ignored. For more information about using these templates, see Understanding Certificate Templates.

        If conflicting or duplicate certificate information is supplied during certificate issuance, Amazon Web Services Private CA applies order of operation rules to determine what information is used.

        Parameters:
        apiPassthrough - Specifies X.509 certificate information to be included in the issued certificate. An APIPassthrough or APICSRPassthrough template variant must be selected, or else this parameter is ignored. For more information about using these templates, see Understanding Certificate Templates.

        If conflicting or duplicate certificate information is supplied during certificate issuance, Amazon Web Services Private CA applies order of operation rules to determine what information is used.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • certificateAuthorityArn

        IssueCertificateRequest.Builder certificateAuthorityArn​(String certificateAuthorityArn)

        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

        Parameters:
        certificateAuthorityArn - 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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • csr

        IssueCertificateRequest.Builder csr​(SdkBytes csr)

        The certificate signing request (CSR) for the certificate you want to issue. As an example, 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 then 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.

        Parameters:
        csr - The certificate signing request (CSR) for the certificate you want to issue. As an example, 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 then 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • signingAlgorithm

        IssueCertificateRequest.Builder signingAlgorithm​(String signingAlgorithm)

        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 in the CreateCertificateAuthority action.

        The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.

        Parameters:
        signingAlgorithm - 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 in the CreateCertificateAuthority action.

        The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SigningAlgorithm, SigningAlgorithm

      • signingAlgorithm

        IssueCertificateRequest.Builder signingAlgorithm​(SigningAlgorithm signingAlgorithm)

        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 in the CreateCertificateAuthority action.

        The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.

        Parameters:
        signingAlgorithm - 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 in the CreateCertificateAuthority action.

        The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SigningAlgorithm, SigningAlgorithm

      • templateArn

        IssueCertificateRequest.Builder templateArn​(String templateArn)

        Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, Amazon Web Services 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.

        For a list of TemplateArn values supported by Amazon Web Services Private CA, see Understanding Certificate Templates.

        Parameters:
        templateArn - Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, Amazon Web Services 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.

        For a list of TemplateArn values supported by Amazon Web Services Private CA, see Understanding Certificate Templates.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • validity

        IssueCertificateRequest.Builder validity​(Validity validity)

        Information describing the end of the validity period of the certificate. This parameter sets the “Not After” date for the certificate.

        Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.

        This value is unaffected when ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the future, the certificate will expire 20 days from issuance time regardless of the ValidityNotBefore value.

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

        Parameters:
        validity - Information describing the end of the validity period of the certificate. This parameter sets the “Not After” date for the certificate.

        Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.

        This value is unaffected when ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the future, the certificate will expire 20 days from issuance time regardless of the ValidityNotBefore value.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • validity

        default IssueCertificateRequest.Builder validity​(Consumer<Validity.Builder> validity)

        Information describing the end of the validity period of the certificate. This parameter sets the “Not After” date for the certificate.

        Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.

        This value is unaffected when ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the future, the certificate will expire 20 days from issuance time regardless of the ValidityNotBefore value.

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

        This is a convenience method that creates an instance of the Validity.Builder avoiding the need to create one manually via Validity.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to validity(Validity).

        Parameters:
        validity - a consumer that will call methods on Validity.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        validity(Validity)

      • validityNotBefore

        IssueCertificateRequest.Builder validityNotBefore​(Validity validityNotBefore)

        Information describing the start of the validity period of the certificate. This parameter sets the “Not Before" date for the certificate.

        By default, when issuing a certificate, Amazon Web Services Private CA sets the "Not Before" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The ValidityNotBefore parameter can be used to customize the “Not Before” value.

        Unlike the Validity parameter, the ValidityNotBefore parameter is optional.

        The ValidityNotBefore value is expressed as an explicit date and time, using the Validity type value ABSOLUTE. For more information, see Validity in this API reference and Validity in RFC 5280.

        Parameters:
        validityNotBefore - Information describing the start of the validity period of the certificate. This parameter sets the “Not Before" date for the certificate.

        By default, when issuing a certificate, Amazon Web Services Private CA sets the "Not Before" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The ValidityNotBefore parameter can be used to customize the “Not Before” value.

        Unlike the Validity parameter, the ValidityNotBefore parameter is optional.

        The ValidityNotBefore value is expressed as an explicit date and time, using the Validity type value ABSOLUTE. For more information, see Validity in this API reference and Validity in RFC 5280.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • validityNotBefore

        default IssueCertificateRequest.Builder validityNotBefore​(Consumer<Validity.Builder> validityNotBefore)

        Information describing the start of the validity period of the certificate. This parameter sets the “Not Before" date for the certificate.

        By default, when issuing a certificate, Amazon Web Services Private CA sets the "Not Before" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The ValidityNotBefore parameter can be used to customize the “Not Before” value.

        Unlike the Validity parameter, the ValidityNotBefore parameter is optional.

        The ValidityNotBefore value is expressed as an explicit date and time, using the Validity type value ABSOLUTE. For more information, see Validity in this API reference and Validity in RFC 5280.

        This is a convenience method that creates an instance of the Validity.Builder avoiding the need to create one manually via Validity.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to validityNotBefore(Validity).

        Parameters:
        validityNotBefore - a consumer that will call methods on Validity.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        validityNotBefore(Validity)

      • idempotencyToken

        IssueCertificateRequest.Builder idempotencyToken​(String idempotencyToken)

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

        Parameters:
        idempotencyToken - Alphanumeric string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens for IssueCertificate time out after five minutes. Therefore, if you call IssueCertificate multiple times with the same idempotency token within five minutes, Amazon Web Services Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificates.
        Returns:
        Returns a reference to this object so that method calls can be chained together.