Class DomainNameProps
Inheritance
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.AWS.APIGateway.dll
Syntax (csharp)
public class DomainNameProps : Object, IDomainNameProps, IDomainNameOptions
Syntax (vb)
Public Class DomainNameProps
Inherits Object
Implements IDomainNameProps, IDomainNameOptions
Remarks
ExampleMetadata: infused
Examples
var acm;
new DomainName(this, "domain-name", new DomainNameProps {
DomainName = "example.com",
Certificate = acm.Certificate.FromCertificateArn(this, "cert", "arn:aws:acm:us-east-1:1111111:certificate/11-3336f1-44483d-adc7-9cd375c5169d"),
Mtls = new MTLSConfig {
Bucket = new Bucket(this, "bucket"),
Key = "truststore.pem",
Version = "version"
}
});
Synopsis
Constructors
DomainNameProps() |
Properties
BasePath | The base path name that callers of the API must provide in the URL after the domain name (e.g. |
Certificate | The reference to an AWS-managed certificate for use by the edge-optimized endpoint for the domain name. |
DomainName | The custom domain name for your API. |
EndpointType | The type of endpoint for this DomainName. |
Mapping | If specified, all requests to this domain will be mapped to the production deployment of this API. |
Mtls | The mutual TLS authentication configuration for a custom domain name. |
SecurityPolicy | The Transport Layer Security (TLS) version + cipher suite for this domain name. |
Constructors
DomainNameProps()
public DomainNameProps()
Properties
BasePath
The base path name that callers of the API must provide in the URL after the domain name (e.g. example.com/base-path
). If you specify this property, it can't be an empty string.
public string BasePath { get; set; }
Property Value
System.String
Remarks
Default: - map requests from the domain root (e.g. example.com
). If this
is undefined, no additional mappings will be allowed on this domain name.
Certificate
The reference to an AWS-managed certificate for use by the edge-optimized endpoint for the domain name.
public ICertificate Certificate { get; set; }
Property Value
Remarks
For "EDGE" domain names, the certificate needs to be in the US East (N. Virginia) region.
DomainName
The custom domain name for your API.
public string DomainName { get; set; }
Property Value
System.String
Remarks
Uppercase letters are not supported.
EndpointType
The type of endpoint for this DomainName.
public Nullable<EndpointType> EndpointType { get; set; }
Property Value
System.Nullable<EndpointType>
Remarks
Default: REGIONAL
Mapping
If specified, all requests to this domain will be mapped to the production deployment of this API.
public IRestApi Mapping { get; set; }
Property Value
Remarks
If you wish to map this domain to multiple APIs
with different base paths, don't specify this option and use
addBasePathMapping
.
Default: - you will have to call addBasePathMapping
to map this domain to
API endpoints.
Mtls
The mutual TLS authentication configuration for a custom domain name.
public IMTLSConfig Mtls { get; set; }
Property Value
Remarks
Default: - mTLS is not configured.
SecurityPolicy
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_0