CfnDomainNameProps Struct
Properties for defining a CfnDomainName.
Example
ts
// 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',
ipAddressType: 'ipAddressType',
ownershipVerificationCertificateArn: 'ownershipVerificationCertificateArn',
securityPolicy: 'securityPolicy',
}],
mutualTlsAuthentication: {
truststoreUri: 'truststoreUri',
truststoreVersion: 'truststoreVersion',
},
routingMode: 'routingMode',
tags: {
tagsKey: 'tags',
},
};
Properties
The custom domain name for your API in Amazon API Gateway.
Uppercase letters and the underscore ( _ ) character are not supported.
domainNameConfigurationsoptionalIResolvable | IResolvable | CfnDomainName.DomainNameConfigurationProperty[]domain_name_configurationsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DomainNameConfigurationProperty]]]domainNameConfigurationsoptionalIResolvableDomainNameConfigurationsoptionalIResolvableDomainNameConfigurationsoptionalinterface{}#The domain name configurations.
mutualTlsAuthenticationoptionalIResolvable | CfnDomainName.MutualTlsAuthenticationPropertymutual_tls_authenticationoptionaltyping.Union[IResolvable, MutualTlsAuthenticationProperty]mutualTlsAuthenticationoptionalIResolvableMutualTlsAuthenticationoptionalIResolvableMutualTlsAuthenticationoptionalinterface{}#The mutual TLS authentication configuration for a custom domain name.
routingModeoptionalstringrouting_modeoptionalstrroutingModeoptionalStringRoutingModeoptionalstringRoutingModeoptional*string= "API_MAPPING_ONLY"#The routing mode API Gateway uses to route traffic to your APIs.
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#The collection of tags associated with a domain name.