Package software.amazon.awssdk.services.acm.model

Interface RequestCertificateRequest.Builder

All Superinterfaces:
AcmRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<RequestCertificateRequest.Builder,RequestCertificateRequest>, SdkBuilder<RequestCertificateRequest.Builder,RequestCertificateRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
RequestCertificateRequest
public static interface RequestCertificateRequest.Builder extends AcmRequest.Builder, SdkPojo, CopyableBuilder<RequestCertificateRequest.Builder,RequestCertificateRequest>

  • Method Details

    • domainName

      RequestCertificateRequest.Builder domainName(String domainName)

      Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com.

      In compliance with RFC 5280, the length of the domain name (technically, the Common Name) that you provide cannot exceed 64 octets (characters), including periods. To add a longer domain name, specify it in the Subject Alternative Name field, which supports names up to 253 octets in length.

      Parameters:
      domainName - Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com.

      In compliance with RFC 5280, the length of the domain name (technically, the Common Name) that you provide cannot exceed 64 octets (characters), including periods. To add a longer domain name, specify it in the Subject Alternative Name field, which supports names up to 253 octets in length.

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

    • validationMethod

      RequestCertificateRequest.Builder validationMethod(String validationMethod)

      The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can validate with DNS or validate with email. We recommend that you use DNS validation.

      Parameters:
      validationMethod - The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can validate with DNS or validate with email. We recommend that you use DNS validation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • validationMethod

      RequestCertificateRequest.Builder validationMethod(ValidationMethod validationMethod)

      The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can validate with DNS or validate with email. We recommend that you use DNS validation.

      Parameters:
      validationMethod - The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can validate with DNS or validate with email. We recommend that you use DNS validation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • subjectAlternativeNames

      RequestCertificateRequest.Builder subjectAlternativeNames(Collection<String> subjectAlternativeNames)

      Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see Quotas.

      The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples:

      • (63 octets).(63 octets).(63 octets).(61 octets) is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.

      • (64 octets).(63 octets).(63 octets).(61 octets) is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.

      • (63 octets).(63 octets).(63 octets).(62 octets) is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.

      Parameters:
      subjectAlternativeNames - Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see Quotas.

      The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples:

      • (63 octets).(63 octets).(63 octets).(61 octets) is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.

      • (64 octets).(63 octets).(63 octets).(61 octets) is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.

      • (63 octets).(63 octets).(63 octets).(62 octets) is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.

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

    • subjectAlternativeNames

      RequestCertificateRequest.Builder subjectAlternativeNames(String... subjectAlternativeNames)

      Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see Quotas.

      The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples:

      • (63 octets).(63 octets).(63 octets).(61 octets) is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.

      • (64 octets).(63 octets).(63 octets).(61 octets) is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.

      • (63 octets).(63 octets).(63 octets).(62 octets) is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.

      Parameters:
      subjectAlternativeNames - Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see Quotas.

      The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples:

      • (63 octets).(63 octets).(63 octets).(61 octets) is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.

      • (64 octets).(63 octets).(63 octets).(61 octets) is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.

      • (63 octets).(63 octets).(63 octets).(62 octets) is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.

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

    • idempotencyToken

      RequestCertificateRequest.Builder idempotencyToken(String idempotencyToken)

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

      Parameters:
      idempotencyToken - Customer chosen string that can be used to distinguish between calls to RequestCertificate. Idempotency tokens time out after one hour. Therefore, if you call RequestCertificate multiple times with the same idempotency token within one hour, ACM recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, ACM recognizes that you are requesting multiple certificates.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • domainValidationOptions

      RequestCertificateRequest.Builder domainValidationOptions(Collection<DomainValidationOption> domainValidationOptions)

      The domain name that you want ACM to use to send you emails so that you can validate domain ownership.

      Parameters:
      domainValidationOptions - The domain name that you want ACM to use to send you emails so that you can validate domain ownership.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • domainValidationOptions

      RequestCertificateRequest.Builder domainValidationOptions(DomainValidationOption... domainValidationOptions)

      The domain name that you want ACM to use to send you emails so that you can validate domain ownership.

      Parameters:
      domainValidationOptions - The domain name that you want ACM to use to send you emails so that you can validate domain ownership.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • domainValidationOptions

      RequestCertificateRequest.Builder domainValidationOptions(Consumer<DomainValidationOption.Builder>... domainValidationOptions)

      The domain name that you want ACM to use to send you emails so that you can validate domain ownership.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to domainValidationOptions(List<DomainValidationOption>).

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

    • options

      RequestCertificateRequest.Builder options(CertificateOptions options)

      Currently, you can use this parameter to specify whether to add the certificate to a certificate transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. For more information, see Opting Out of Certificate Transparency Logging.

      Parameters:
      options - Currently, you can use this parameter to specify whether to add the certificate to a certificate transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. For more information, see Opting Out of Certificate Transparency Logging.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • options

      default RequestCertificateRequest.Builder options(Consumer<CertificateOptions.Builder> options)

      Currently, you can use this parameter to specify whether to add the certificate to a certificate transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. For more information, see Opting Out of Certificate Transparency Logging.

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

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

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

    • certificateAuthorityArn

      RequestCertificateRequest.Builder certificateAuthorityArn(String certificateAuthorityArn)

      The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the Amazon Web Services Private Certificate Authority user guide. The ARN must have the following form:

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

      Parameters:
      certificateAuthorityArn - The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the Amazon Web Services Private Certificate Authority user guide. The ARN must have the following 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.

    • tags

      RequestCertificateRequest.Builder tags(Collection<Tag> tags)

      One or more resource tags to associate with the certificate.

      Parameters:
      tags - One or more resource tags to associate with the certificate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      RequestCertificateRequest.Builder tags(Tag... tags)

      One or more resource tags to associate with the certificate.

      Parameters:
      tags - One or more resource tags to associate with the certificate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      RequestCertificateRequest.Builder tags(Consumer<Tag.Builder>... tags)

      One or more resource tags to associate with the certificate.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

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

    • keyAlgorithm

      RequestCertificateRequest.Builder keyAlgorithm(String keyAlgorithm)

      Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but with greater computing efficiency. However, ECDSA is not supported by all network clients. Some Amazon Web Services services may require RSA keys, or only support ECDSA keys of a particular size, while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not broken. Check the requirements for the Amazon Web Services service where you plan to deploy your certificate. For more information about selecting an algorithm, see Key algorithms.

      Algorithms supported for an ACM certificate request include:

      • RSA_2048

      • EC_prime256v1

      • EC_secp384r1

      Other listed algorithms are for imported certificates only.

      When you request a private PKI certificate signed by a CA from Amazon Web Services Private CA, the specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.

      Default: RSA_2048

      Parameters:
      keyAlgorithm - Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but with greater computing efficiency. However, ECDSA is not supported by all network clients. Some Amazon Web Services services may require RSA keys, or only support ECDSA keys of a particular size, while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not broken. Check the requirements for the Amazon Web Services service where you plan to deploy your certificate. For more information about selecting an algorithm, see Key algorithms.

      Algorithms supported for an ACM certificate request include:

      • RSA_2048

      • EC_prime256v1

      • EC_secp384r1

      Other listed algorithms are for imported certificates only.

      When you request a private PKI certificate signed by a CA from Amazon Web Services Private CA, the specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.

      Default: RSA_2048

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

    • keyAlgorithm

      RequestCertificateRequest.Builder keyAlgorithm(KeyAlgorithm keyAlgorithm)

      Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but with greater computing efficiency. However, ECDSA is not supported by all network clients. Some Amazon Web Services services may require RSA keys, or only support ECDSA keys of a particular size, while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not broken. Check the requirements for the Amazon Web Services service where you plan to deploy your certificate. For more information about selecting an algorithm, see Key algorithms.

      Algorithms supported for an ACM certificate request include:

      • RSA_2048

      • EC_prime256v1

      • EC_secp384r1

      Other listed algorithms are for imported certificates only.

      When you request a private PKI certificate signed by a CA from Amazon Web Services Private CA, the specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.

      Default: RSA_2048

      Parameters:
      keyAlgorithm - Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but with greater computing efficiency. However, ECDSA is not supported by all network clients. Some Amazon Web Services services may require RSA keys, or only support ECDSA keys of a particular size, while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not broken. Check the requirements for the Amazon Web Services service where you plan to deploy your certificate. For more information about selecting an algorithm, see Key algorithms.

      Algorithms supported for an ACM certificate request include:

      • RSA_2048

      • EC_prime256v1

      • EC_secp384r1

      Other listed algorithms are for imported certificates only.

      When you request a private PKI certificate signed by a CA from Amazon Web Services Private CA, the specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.

      Default: RSA_2048

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

    • overrideConfiguration

      RequestCertificateRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      RequestCertificateRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.