Interface IDomainNameOptions

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IDomainNameOptions

Syntax (vb)

Public Interface IDomainNameOptions

Remarks

ExampleMetadata: infused

Examples

var acmCertificateForExampleCom;


var api = new RestApi(this, "MyDomain", new RestApiProps {
    DomainName = new DomainNameOptions {
        DomainName = "example.com",
        Certificate = acmCertificateForExampleCom
    }
});

Synopsis

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.
Mtls	The mutual TLS authentication configuration for a custom domain name.
SecurityPolicy	The Transport Layer Security (TLS) version + cipher suite for this domain name.

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.

virtual string BasePath { get; }

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.

ICertificate Certificate { get; }

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.

string DomainName { get; }

Property Value

System.String

Remarks

Uppercase letters are not supported.

EndpointType

The type of endpoint for this DomainName.

virtual Nullable<EndpointType> EndpointType { get; }

Property Value

System.Nullable<EndpointType>

Remarks

Default: REGIONAL

Mtls

The mutual TLS authentication configuration for a custom domain name.

virtual IMTLSConfig Mtls { get; }

Property Value

IMTLSConfig

Remarks

Default: - mTLS is not configured.

SecurityPolicy

The Transport Layer Security (TLS) version + cipher suite for this domain name.

virtual Nullable<SecurityPolicy> SecurityPolicy { get; }

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