@aws-cdk_aws-apigatewayv2-alpha.DomainNameProps

interface DomainNameProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.Alpha.DomainNameProps
Gogithub.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2#DomainNameProps
Javasoftware.amazon.awscdk.services.apigatewayv2.alpha.DomainNameProps
Pythonaws_cdk.aws_apigatewayv2_alpha.DomainNameProps
TypeScript (source)@aws-cdk/aws-apigatewayv2-alpha ยป DomainNameProps

properties used for creating the DomainName.

Example

import * as acm from 'aws-cdk-lib/aws-certificatemanager';
import { HttpLambdaIntegration } from '@aws-cdk/aws-apigatewayv2-integrations-alpha';

const certArn = 'arn:aws:acm:us-east-1:111111111111:certificate';
const domainName = 'example.com';

const dn = new apigwv2.DomainName(this, 'DN', {
  domainName: domainName,
  certificate: acm.Certificate.fromCertificateArn(this, 'cert', certArn),
});

declare const handler: lambda.Function;
const api = new apigwv2.HttpApi(this, 'HttpProxyProdApi', {
  defaultIntegration: new HttpLambdaIntegration('DefaultIntegration', handler),
  // https://${dn.domainName}/foo goes to prodApi $default stage
  defaultDomainMapping: {
    domainName: dn,
    mappingKey: 'foo',
  },
});

Properties

NameTypeDescription
certificate๐Ÿ”นICertificateThe ACM certificate for this domain name.
domainName๐Ÿ”นstringThe custom domain name.
certificateName?๐Ÿ”นstringThe user-friendly name of the certificate that will be used by the endpoint for this domain name.
endpointType?๐Ÿ”นEndpointTypeThe type of endpoint for this DomainName.
mtls?๐Ÿ”นMTLSConfigThe mutual TLS authentication configuration for a custom domain name.
ownershipCertificate?๐Ÿ”นICertificateA public certificate issued by ACM to validate that you own a custom domain.
securityPolicy?๐Ÿ”นSecurityPolicyThe Transport Layer Security (TLS) version + cipher suite for this domain name.

certificate๐Ÿ”น

Type: ICertificate

The ACM certificate for this domain name.

Certificate can be both ACM issued or imported.


domainName๐Ÿ”น

Type: string

The custom domain name.


certificateName?๐Ÿ”น

Type: string (optional, default: No friendly certificate name)

The user-friendly name of the certificate that will be used by the endpoint for this domain name.


endpointType?๐Ÿ”น

Type: EndpointType (optional, default: EndpointType.REGIONAL)

The type of endpoint for this DomainName.


mtls?๐Ÿ”น

Type: MTLSConfig (optional, default: mTLS is not configured.)

The mutual TLS authentication configuration for a custom domain name.


ownershipCertificate?๐Ÿ”น

Type: ICertificate (optional, default: only required when configuring mTLS)

A public certificate issued by ACM to validate that you own a custom domain.

This parameter is required only when you configure mutual TLS authentication and you specify an ACM imported or private CA certificate for certificate. The ownership certificate validates that you have permissions to use the domain name.


securityPolicy?๐Ÿ”น

Type: SecurityPolicy (optional, default: SecurityPolicy.TLS_1_2)

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