GradientEdge CDK Utils
    Preparing search index...

    Interface AcmProps

    interface AcmProps {
        allowExport?: boolean;
        certificateAccount?: string;
        certificateArn?: string;
        certificateId?: string;
        certificateName?: string;
        certificateRegion?: string;
        certificateSsmName?: string;
        domainName: string;
        keyAlgorithm?: KeyAlgorithm;
        subjectAlternativeNames?: string[];
        transparencyLoggingEnabled?: boolean;
        useExistingCertificate: boolean;
        validation?: CertificateValidation;
    }

    Hierarchy

    • CertificateProps
      • AcmProps
    Index

    Properties

    allowExport? certificateAccount? certificateArn? certificateId? certificateName? certificateRegion? certificateSsmName? domainName keyAlgorithm? subjectAlternativeNames? transparencyLoggingEnabled? useExistingCertificate validation?

    Properties

    allowExport?: boolean

    Enable or disable export of this certificate.

    If you issue an exportable public certificate, there is a charge at certificate issuance and again when the certificate renews. Ref: https://aws.amazon.com/certificate-manager/pricing

    false
    certificateAccount?: string

    The AWS account ID where the certificate resides

    certificateArn?: string

    The full ARN of an existing certificate to import

    certificateId?: string

    The certificate ID used to construct an ARN when certificateArn is not provided

    certificateName?: string

    The Certificate name.

    Since the Certificate resource doesn't support providing a physical name, the value provided here will be recorded in the Name tag

    the full, absolute path of this construct
    certificateRegion?: string

    The AWS region where the certificate resides

    certificateSsmName?: string

    The SSM parameter name storing the certificate reference

    domainName: string

    Fully-qualified domain name to request a certificate for.

    May contain wildcards, such as *.domain.com.

    keyAlgorithm?: KeyAlgorithm

    Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data.

    https://docs.aws.amazon.com/acm/latest/userguide/acm-certificate.html#algorithms.title

    KeyAlgorithm.RSA_2048
    subjectAlternativeNames?: string[]

    Alternative domain names on your certificate.

    Use this to register alternative domain names that represent the same site.

    - No additional FQDNs will be included as alternative domain names.
    transparencyLoggingEnabled?: boolean

    Enable or disable transparency logging for this certificate

    Once a certificate has been logged, it cannot be removed from the log. Opting out at that point will have no effect. If you opt out of logging when you request a certificate and then choose later to opt back in, your certificate will not be logged until it is renewed. If you want the certificate to be logged immediately, we recommend that you issue a new one.

    https://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency

    true
    useExistingCertificate: boolean

    Whether to import an existing certificate instead of creating a new one

    validation?: CertificateValidation

    How to validate this certificate

    CertificateValidation.fromEmail()

    Settings

    Member Visibility

    On This Page

    Properties