AwsApiGatewayHttpCustomDomainArgs

interface AwsApiGatewayHttpCustomDomainArgs {
apiMappingKey?: Input<string>;
certificateArn: Input<string>;
domainName: Input<string>;
ipAddressType?: Input<AwsApiGatewayHttpCustomDomainIpAddressType>;
mappingTarget?: AwsApiGatewayHttpCustomDomainMappingTargetArgs;
mutualTlsAuthentication?: AwsApiGatewayHttpCustomDomainMutualTlsAuthenticationArgs;
routingMode?: Input<AwsApiGatewayHttpCustomDomainRoutingMode>;
securityPolicy?: Input<'TLS_1_2'>;
}

HTTP custom-domain settings for AwsApiGatewayHttpArgs.

Example

CODE

const customDomain: AwsApiGatewayHttpCustomDomainArgs = {
  domainName: 'http-api.example.com',
  certificateArn: certificate.arn,
};

Properties

`apiMappingKey: Input<string>`

Optional API mapping key (base path).

`certificateArn: Input<string>`

ACM certificate ARN for the HTTP API custom domain.

`domainName: Input<string>`

Fully qualified domain name for API Gateway custom domain.

`ipAddressType: Input<AwsApiGatewayHttpCustomDomainIpAddressType>`

Optional IP address type. Defaults to ipv4.

`mappingTarget: AwsApiGatewayHttpCustomDomainMappingTargetArgs`

Optional API mapping target override. When omitted, the mapping points to the HTTP API and stage created by this component.

`mutualTlsAuthentication: AwsApiGatewayHttpCustomDomainMutualTlsAuthenticationArgs`

Optional mutual TLS configuration.

`routingMode: Input<AwsApiGatewayHttpCustomDomainRoutingMode>`

Optional domain routing mode. Defaults to API_MAPPING_ONLY.

`securityPolicy: Input<'TLS_1_2'>`

Optional TLS security policy. Defaults to TLS_1_2.