Interface ICertificateProps
Properties for your certificate.
Namespace: Amazon.CDK.AWS.CertificateManager
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICertificateProps
Syntax (vb)
Public Interface ICertificateProps
Remarks
ExampleMetadata: infused
Examples
var exampleCom = new HostedZone(this, "ExampleCom", new HostedZoneProps {
ZoneName = "example.com"
});
var exampleNet = new HostedZone(this, "ExampleNet", new HostedZoneProps {
ZoneName = "example.net"
});
var cert = new Certificate(this, "Certificate", new CertificateProps {
DomainName = "test.example.com",
SubjectAlternativeNames = new [] { "cool.example.com", "test.example.net" },
Validation = CertificateValidation.FromDnsMultiZone(new Dictionary<string, IHostedZone> {
{ "test.example.com", exampleCom },
{ "cool.example.com", exampleCom },
{ "test.example.net", exampleNet }
})
});
Synopsis
Properties
CertificateName | The Certificate name. |
DomainName | Fully-qualified domain name to request a certificate for. |
KeyAlgorithm | Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. |
SubjectAlternativeNames | Alternative domain names on your certificate. |
TransparencyLoggingEnabled | Enable or disable transparency logging for this certificate. |
Validation | How to validate this certificate. |
Properties
CertificateName
The Certificate name.
virtual string CertificateName { get; }
Property Value
System.String
Remarks
Since the Certificate resource doesn't support providing a physical name, the value provided here will be recorded in the Name
tag
Default: the full, absolute path of this construct
DomainName
Fully-qualified domain name to request a certificate for.
string DomainName { get; }
Property Value
System.String
Remarks
May contain wildcards, such as *.domain.com
.
KeyAlgorithm
Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data.
virtual KeyAlgorithm KeyAlgorithm { get; }
Property Value
Remarks
Default: KeyAlgorithm.RSA_2048
See: https://docs.aws.amazon.com/acm/latest/userguide/acm-certificate.html#algorithms.title
SubjectAlternativeNames
Alternative domain names on your certificate.
virtual string[] SubjectAlternativeNames { get; }
Property Value
System.String[]
Remarks
Use this to register alternative domain names that represent the same site.
Default: - No additional FQDNs will be included as alternative domain names.
TransparencyLoggingEnabled
Enable or disable transparency logging for this certificate.
virtual Nullable<bool> TransparencyLoggingEnabled { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
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.
Default: true
See: https://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency
Validation
How to validate this certificate.
virtual CertificateValidation Validation { get; }
Property Value
Remarks
Default: CertificateValidation.fromEmail()