interface CfnDomainNameProps

Language	Type name
.NET	`Amazon.CDK.AWS.APIGatewayv2.CfnDomainNameProps`
Java	`software.amazon.awscdk.services.apigatewayv2.CfnDomainNameProps`
Python	`aws_cdk.aws_apigatewayv2.CfnDomainNameProps`
TypeScript	`@aws-cdk/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 * as apigatewayv2 from '@aws-cdk/aws-apigatewayv2';

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

Name	Type	Description
domainName	`string`	The custom domain name for your API in Amazon API Gateway.
domainNameConfigurations?	`IResolvable` `\|` `IResolvable` `\|` `DomainNameConfigurationProperty[]`	The domain name configurations.
mutualTlsAuthentication?	`IResolvable` `\|` `MutualTlsAuthenticationProperty`	The mutual TLS authentication configuration for a custom domain name.
tags?	`any`	The 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.