AwsServerlessApiGatewayHttpCustomDomainArgs

interface AwsServerlessApiGatewayHttpCustomDomainArgs extends Omit<AwsApiGatewayHttpCustomDomainArgs, 'certificateArn'> {
apiMappingKey?: Input<string>;
certificateArn?: Input<string>;
certificateSettings?: AwsServerlessApiGatewayCustomDomainCertificateArgs;
domainName: Input<string>;
ipAddressType?: Input<AwsApiGatewayHttpCustomDomainIpAddressType>;
mappingTarget?: AwsApiGatewayHttpCustomDomainMappingTargetArgs;
mutualTlsAuthentication?: AwsApiGatewayHttpCustomDomainMutualTlsAuthenticationArgs;
route53AliasRecord?: AwsServerlessApiGatewayHttpRoute53AliasRecordArgs;
routingMode?: Input<AwsApiGatewayHttpCustomDomainRoutingMode>;
securityPolicy?: Input<'TLS_1_2'>;
}

Serverless HTTP custom-domain settings.

Remarks

Unlike AwsApiGatewayHttpCustomDomainArgs, certificateArn is optional here so AwsServerless can orchestrate ACM automatically when needed. Configure exactly one certificate source: certificateArn or certificateSettings.

Example

CODE

const customDomain: AwsServerlessApiGatewayHttpCustomDomainArgs = {
  domainName: 'http.orders.example.com',
  certificateSettings: {
    privateZone: false,
  },
  route53AliasRecord: {
    hostedZoneName: 'orders.example.com',
  },
};

Hierarchy

Omit<AwsApiGatewayHttpCustomDomainArgs, "certificateArn">
AwsServerlessApiGatewayHttpCustomDomainArgs

Properties

`apiMappingKey: Input<string>`

Inherited from apiMappingKey

Optional API mapping key (base path).

`certificateArn: Input<string>`

Optional ACM certificate ARN. When omitted, AwsServerless can orchestrate ACM automatically.

`certificateSettings: AwsServerlessApiGatewayCustomDomainCertificateArgs`

Optional ACM certificate orchestration for HTTP custom domains when certificateArn is not provided.

`domainName: Input<string>`

Inherited from domainName

Fully qualified domain name for API Gateway custom domain.

`ipAddressType: Input<AwsApiGatewayHttpCustomDomainIpAddressType>`

Inherited from ipAddressType

Optional IP address type. Defaults to ipv4.

`mappingTarget: AwsApiGatewayHttpCustomDomainMappingTargetArgs`

Inherited from mappingTarget

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

`mutualTlsAuthentication: AwsApiGatewayHttpCustomDomainMutualTlsAuthenticationArgs`

Inherited from mutualTlsAuthentication

Optional mutual TLS configuration.

`route53AliasRecord: AwsServerlessApiGatewayHttpRoute53AliasRecordArgs`

Optional Route53 alias-record settings for this HTTP custom domain.

`routingMode: Input<AwsApiGatewayHttpCustomDomainRoutingMode>`

Inherited from routingMode

Optional domain routing mode. Defaults to API_MAPPING_ONLY.

`securityPolicy: Input<'TLS_1_2'>`

Inherited from securityPolicy

Optional TLS security policy. Defaults to TLS_1_2.