Interface IDomainNameProps

properties used for creating the DomainName.

Inherited Members
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IDomainNameProps : IEndpointOptions
Syntax (vb)
Public Interface IDomainNameProps
    Inherits IEndpointOptions
Remarks

ExampleMetadata: infused

Examples
using Amazon.CDK.AWS.CertificateManager;
using Amazon.CDK.AwsApigatewayv2Integrations;

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

Properties

DomainName

The custom domain name.
Mtls

The mutual TLS authentication configuration for a custom domain name.

Properties

DomainName

The custom domain name.

string DomainName { get; }
Property Value

System.String

Mtls

The mutual TLS authentication configuration for a custom domain name.

virtual IMTLSConfig Mtls { get; }
Property Value

IMTLSConfig

Remarks

Default: - mTLS is not configured.