Package software.amazon.awscdk.services.certificatemanager

Class CfnCertificateProps.Builder

java.lang.Object
software.amazon.awscdk.services.certificatemanager.CfnCertificateProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnCertificateProps>
Enclosing interface:
CfnCertificateProps
@Stability(Stable) public static final class CfnCertificateProps.Builder extends Object implements software.amazon.jsii.Builder<CfnCertificateProps>
A builder for CfnCertificateProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • domainName

      @Stability(Stable) public CfnCertificateProps.Builder domainName(String domainName)
      Sets the value of CfnCertificateProps.getDomainName()
      Parameters:
      domainName - The fully qualified domain name (FQDN), such as www.example.com, with which you want to secure 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.. This parameter is required.
      Returns:
      this

    • certificateAuthorityArn

      @Stability(Stable) public CfnCertificateProps.Builder certificateAuthorityArn(String certificateAuthorityArn)
      Sets the value of CfnCertificateProps.getCertificateAuthorityArn()
      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 AWS 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:
      this

    • certificateTransparencyLoggingPreference

      @Stability(Stable) public CfnCertificateProps.Builder certificateTransparencyLoggingPreference(String certificateTransparencyLoggingPreference)
      Sets the value of CfnCertificateProps.getCertificateTransparencyLoggingPreference()
      Parameters:
      certificateTransparencyLoggingPreference - You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED . If you do not specify a certificate transparency logging preference on a new CloudFormation template, or if you remove the logging preference from an existing template, this is the same as explicitly enabling the preference.

      Changing the certificate transparency logging preference will update the existing resource by calling UpdateCertificateOptions on the certificate. This action will not create a new resource.

      Returns:
      this

    • domainValidationOptions

      @Stability(Stable) public CfnCertificateProps.Builder domainValidationOptions(IResolvable domainValidationOptions)
      Sets the value of CfnCertificateProps.getDomainValidationOptions()
      Parameters:
      domainValidationOptions - Domain information that domain name registrars use to verify your identity.

      In order for a AWS::CertificateManager::Certificate to be provisioned and validated in CloudFormation automatically, the DomainName property needs to be identical to one of the DomainName property supplied in DomainValidationOptions, if the ValidationMethod is DNS. Failing to keep them like-for-like will result in failure to create the domain validation records in Route53.

      Returns:
      this

    • domainValidationOptions

      @Stability(Stable) public CfnCertificateProps.Builder domainValidationOptions(List<? extends Object> domainValidationOptions)
      Sets the value of CfnCertificateProps.getDomainValidationOptions()
      Parameters:
      domainValidationOptions - Domain information that domain name registrars use to verify your identity.

      In order for a AWS::CertificateManager::Certificate to be provisioned and validated in CloudFormation automatically, the DomainName property needs to be identical to one of the DomainName property supplied in DomainValidationOptions, if the ValidationMethod is DNS. Failing to keep them like-for-like will result in failure to create the domain validation records in Route53.

      Returns:
      this

    • keyAlgorithm

      @Stability(Stable) public CfnCertificateProps.Builder keyAlgorithm(String keyAlgorithm)
      Sets the value of CfnCertificateProps.getKeyAlgorithm()
      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 AWS 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 AWS 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 AWS 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:
      this

    • subjectAlternativeNames

      @Stability(Stable) public CfnCertificateProps.Builder subjectAlternativeNames(List<String> subjectAlternativeNames)
      Sets the value of CfnCertificateProps.getSubjectAlternativeNames()
      Parameters:
      subjectAlternativeNames - Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, you can add 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.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnCertificateProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnCertificateProps.getTags()
      Parameters:
      tags - Key-value pairs that can identify the certificate.
      Returns:
      this

    • validationMethod

      @Stability(Stable) public CfnCertificateProps.Builder validationMethod(String validationMethod)
      Sets the value of CfnCertificateProps.getValidationMethod()
      Parameters:
      validationMethod - The method you want to use to validate that you own or control the domain associated with a public certificate. You can validate with DNS or validate with email . We recommend that you use DNS validation.

      If not specified, this property defaults to email validation.

      Returns:
      this

    • build

      @Stability(Stable) public CfnCertificateProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnCertificateProps>
      Returns:
      a new instance of CfnCertificateProps
      Throws:
      NullPointerException - if any required attribute was not provided