Class DomainNameOptions

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

public class DomainNameOptions : IDomainNameOptions

Inheritance

object

DomainNameOptions

Implements

IDomainNameOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

var acmCertificateForExampleCom;


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

Remarks

ExampleMetadata: infused

Constructors

DomainNameOptions()

public DomainNameOptions()

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

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

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

string

Remarks

Uppercase letters are not supported.

EndpointType

The type of endpoint for this DomainName.

public EndpointType? EndpointType { get; set; }

Property Value

EndpointType?

Remarks

Default: REGIONAL

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 SecurityPolicy? SecurityPolicy { get; set; }

Property Value

SecurityPolicy?

Remarks

Default: SecurityPolicy.TLS_1_0

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