Class DomainNameProps

Inheritance
System.Object
DomainNameProps
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class DomainNameProps : Object, IDomainNameProps, IDomainNameOptions
Syntax (vb)
Public Class DomainNameProps
    Inherits Object
    Implements IDomainNameProps, 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

Constructors

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.
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).

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

ICertificate

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

IRestApi

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.

Mtls

The mutual TLS authentication configuration for a custom domain name.

public IMTLSConfig Mtls { get; set; }
Property Value

IMTLSConfig

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_2

See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html

Implements