CfnDomainNameV2Props Struct
Properties for defining a CfnDomainNameV2.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
declare const policy: any;
const cfnDomainNameV2Props: apigateway.CfnDomainNameV2Props = {
certificateArn: 'certificateArn',
domainName: 'domainName',
endpointAccessMode: 'endpointAccessMode',
endpointConfiguration: {
ipAddressType: 'ipAddressType',
types: ['types'],
},
policy: policy,
routingMode: 'routingMode',
securityPolicy: 'securityPolicy',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
certificateArnstringcertificate_arnstrcertificateArnStringCertificateArnstringCertificateArn*string#The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name.
AWS Certificate Manager is the only supported source.
Represents a custom domain name as a user-friendly host name of an API (RestApi).
endpointAccessModestringendpoint_access_modestrendpointAccessModeStringEndpointAccessModestringEndpointAccessMode*string#The endpoint access mode for your DomainName.
endpointConfigurationIResolvable | CfnDomainNameV2.EndpointConfigurationPropertyendpoint_configurationtyping.Union[IResolvable, EndpointConfigurationProperty]endpointConfigurationIResolvableEndpointConfigurationIResolvableEndpointConfigurationinterface{}#The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.
A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration.
You can use Fn::ToJsonString to enter your policy . For more information, see Fn::ToJsonString .
routingModestringrouting_modestrroutingModeStringRoutingModestringRoutingMode*string= "BASE_PATH_MAPPING_ONLY"#The routing mode for this domain name.
The routing mode determines how API Gateway sends traffic from your custom domain name to your private APIs.
securityPolicystringsecurity_policystrsecurityPolicyStringSecurityPolicystringSecurityPolicy*string#The Transport Layer Security (TLS) version + cipher suite for this DomainName.