Interface IDomainNameProps
Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IDomainNameProps : IDomainNameOptions
Syntax (vb)
Public Interface IDomainNameProps
Inherits IDomainNameOptions
Remarks
ExampleMetadata: infused
Examples
var acmCertificateForExampleCom;
RestApi restApi;
new DomainName(this, "custom-domain", new DomainNameProps {
DomainName = "example.com",
Certificate = acmCertificateForExampleCom,
Mapping = restApi,
BasePath = "orders/v1/api"
});
Synopsis
Properties
Mapping | If specified, all requests to this domain will be mapped to the production deployment of this API. |
Properties
Mapping
If specified, all requests to this domain will be mapped to the production deployment of this API.
virtual IRestApi Mapping { get; }
Property Value
Remarks
If you wish to map this domain to multiple APIs
with different base paths, use addBasePathMapping
or addApiMapping
.
Default: - you will have to call addBasePathMapping
to map this domain to
API endpoints.