Class DomainNameProps
(experimental) properties used for creating the DomainName.
Inheritance
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class DomainNameProps : Object, IDomainNameProps, IEndpointOptions
Syntax (vb)
Public Class DomainNameProps
Inherits Object
Implements IDomainNameProps, IEndpointOptions
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
using Amazon.CDK.AWS.CertificateManager;
using Amazon.CDK.AWS.APIGatewayv2.Integrations;
Function handler;
var certArn = "arn:aws:acm:us-east-1:111111111111:certificate";
var domainName = "example.com";
var dn = new DomainName(this, "DN", new DomainNameProps {
DomainName = domainName,
Certificate = Certificate.FromCertificateArn(this, "cert", certArn)
});
var api = new HttpApi(this, "HttpProxyProdApi", new HttpApiProps {
DefaultIntegration = new HttpLambdaIntegration("DefaultIntegration", handler),
// https://${dn.domainName}/foo goes to prodApi $default stage
DefaultDomainMapping = new DomainMappingOptions {
DomainName = dn,
MappingKey = "foo"
}
});
Synopsis
Constructors
DomainNameProps() |
Properties
Certificate | (experimental) The ACM certificate for this domain name. |
CertificateName | (experimental) The user-friendly name of the certificate that will be used by the endpoint for this domain name. |
DomainName | (experimental) The custom domain name. |
EndpointType | (experimental) The type of endpoint for this DomainName. |
Mtls | (experimental) The mutual TLS authentication configuration for a custom domain name. |
OwnershipCertificate | (experimental) A public certificate issued by ACM to validate that you own a custom domain. |
SecurityPolicy | (experimental) The Transport Layer Security (TLS) version + cipher suite for this domain name. |
Constructors
DomainNameProps()
public DomainNameProps()
Properties
Certificate
(experimental) The ACM certificate for this domain name.
public ICertificate Certificate { get; set; }
Property Value
Remarks
Certificate can be both ACM issued or imported.
Stability: Experimental
CertificateName
(experimental) The user-friendly name of the certificate that will be used by the endpoint for this domain name.
public string CertificateName { get; set; }
Property Value
System.String
Remarks
Default: - No friendly certificate name
Stability: Experimental
DomainName
(experimental) The custom domain name.
public string DomainName { get; set; }
Property Value
System.String
Remarks
Stability: Experimental
EndpointType
(experimental) The type of endpoint for this DomainName.
public Nullable<EndpointType> EndpointType { get; set; }
Property Value
System.Nullable<EndpointType>
Remarks
Default: EndpointType.REGIONAL
Stability: Experimental
Mtls
(experimental) The mutual TLS authentication configuration for a custom domain name.
public IMTLSConfig Mtls { get; set; }
Property Value
Remarks
Default: - mTLS is not configured.
Stability: Experimental
OwnershipCertificate
(experimental) A public certificate issued by ACM to validate that you own a custom domain.
public ICertificate OwnershipCertificate { get; set; }
Property Value
Remarks
This parameter is required
only when you configure mutual TLS authentication and you specify an ACM imported or private CA certificate
for certificate
. The ownership certificate validates that you have permissions to use the domain name.
Default: - only required when configuring mTLS
Stability: Experimental
SecurityPolicy
(experimental) The Transport Layer Security (TLS) version + cipher suite for this domain name.
public Nullable<SecurityPolicy> SecurityPolicy { get; set; }
Property Value
System.Nullable<SecurityPolicy>
Remarks
Default: SecurityPolicy.TLS_1_2
Stability: Experimental