interface CfnDomainNameProps

Language	Type name
.NET	Amazon.CDK.AWS.Apigatewayv2.CfnDomainNameProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#CfnDomainNameProps
Java	software.amazon.awscdk.services.apigatewayv2.CfnDomainNameProps
Python	aws_cdk.aws_apigatewayv2.CfnDomainNameProps
TypeScript	aws-cdk-lib » aws_apigatewayv2 » CfnDomainNameProps

Properties for defining a CfnDomainName.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html

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';
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: {
    tagsKey: '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?	{ [string]: string }	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 and the underscore ( _ ) character are not supported.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-domainname

---

domainNameConfigurations?

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

The domain name configurations.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-domainnameconfigurations

---

mutualTlsAuthentication?

Type: IResolvable | MutualTlsAuthenticationProperty (optional)

The mutual TLS authentication configuration for a custom domain name.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-mutualtlsauthentication

---

tags?

Type: { [string]: string } (optional)

The collection of tags associated with a domain name.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-tags