aws-cdk-lib.aws_apigatewayv2.CfnDomainNameProps

interface CfnDomainNameProps

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.CfnDomainNameProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#CfnDomainNameProps
Javasoftware.amazon.awscdk.services.apigatewayv2.CfnDomainNameProps
Pythonaws_cdk.aws_apigatewayv2.CfnDomainNameProps
TypeScript aws-cdk-lib » aws_apigatewayv2 » CfnDomainNameProps

Properties for defining a CfnDomainName.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';

declare const tags: any;
const cfnDomainNameProps: apigatewayv2.CfnDomainNameProps = {
  domainName: 'domainName',

  // the properties below are optional
  domainNameConfigurations: [{
    certificateArn: 'certificateArn',
    certificateName: 'certificateName',
    endpointType: 'endpointType',
    ownershipVerificationCertificateArn: 'ownershipVerificationCertificateArn',
    securityPolicy: 'securityPolicy',
  }],
  mutualTlsAuthentication: {
    truststoreUri: 'truststoreUri',
    truststoreVersion: 'truststoreVersion',
  },
  tags: tags,
};

Properties

NameTypeDescription
domainNamestringThe custom domain name for your API in Amazon API Gateway.
domainNameConfigurations?IResolvable | IResolvable | DomainNameConfigurationProperty[]The domain name configurations.
mutualTlsAuthentication?IResolvable | MutualTlsAuthenticationPropertyThe mutual TLS authentication configuration for a custom domain name.
tags?anyThe collection of tags associated with a domain name.

domainName

Type: string

The custom domain name for your API in Amazon API Gateway.

Uppercase letters are not supported.


domainNameConfigurations?

Type: IResolvable | IResolvable | DomainNameConfigurationProperty[] (optional)

The domain name configurations.


mutualTlsAuthentication?

Type: IResolvable | MutualTlsAuthenticationProperty (optional)

The mutual TLS authentication configuration for a custom domain name.


tags?

Type: any (optional)

The collection of tags associated with a domain name.