AwsServerlessApiGatewayRestCustomDomainArgs

interface AwsServerlessApiGatewayRestCustomDomainArgs extends Omit<AwsApiGatewayRestCustomDomainArgs, 'certificate'> {
basePath?: Input<string>;
certificate?: AwsApiGatewayRestCustomDomainCertificateArgs;
certificateSettings?: AwsServerlessApiGatewayCustomDomainCertificateArgs;
domainName: Input<string>;
endpointAccessMode?: Input<AwsApiGatewayRestCustomDomainEndpointAccessMode>;
endpointType?: AwsApiGatewayRestCustomDomainEndpointType;
mappingTarget?: AwsApiGatewayRestCustomDomainMappingTargetArgs;
route53AliasRecord?: AwsServerlessApiGatewayRestRoute53AliasRecordArgs;
securityPolicy?: Input<string>;
}

Serverless REST custom-domain settings.

Remarks

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

Example

CODE

const customDomain: AwsServerlessApiGatewayRestCustomDomainArgs = {
  domainName: 'api.orders.example.com',
  endpointType: 'REGIONAL',
  certificateSettings: {
    subjectAlternativeNames: ['orders.example.com'],
  },
  route53AliasRecord: {
    hostedZoneName: 'orders.example.com',
  },
};

Hierarchy

Omit<AwsApiGatewayRestCustomDomainArgs, "certificate">
AwsServerlessApiGatewayRestCustomDomainArgs

Properties

`basePath: Input<string>`

Inherited from basePath

Optional base path mapping value.

`certificate: AwsApiGatewayRestCustomDomainCertificateArgs`

Optional certificate settings. When omitted, AwsServerless can orchestrate ACM automatically for REGIONAL endpoints.

`certificateSettings: AwsServerlessApiGatewayCustomDomainCertificateArgs`

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

`domainName: Input<string>`

Inherited from domainName

Fully qualified domain name for API Gateway custom domain.

`endpointAccessMode: Input<AwsApiGatewayRestCustomDomainEndpointAccessMode>`

Inherited from endpointAccessMode

Optional endpoint access mode. Defaults to BASIC when using SecurityPolicy_* policies.

`endpointType: AwsApiGatewayRestCustomDomainEndpointType`

Inherited from endpointType

Endpoint type. Defaults to REGIONAL.

`mappingTarget: AwsApiGatewayRestCustomDomainMappingTargetArgs`

Inherited from mappingTarget

Optional base-path mapping target override. When omitted, the mapping points to the REST API and stage created by this component.

`route53AliasRecord: AwsServerlessApiGatewayRestRoute53AliasRecordArgs`

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

`securityPolicy: Input<string>`

Inherited from securityPolicy

Optional TLS security policy for the custom domain. Defaults to SecurityPolicy_TLS13_1_3_2025_09 for REGIONAL and SecurityPolicy_TLS13_2025_EDGE for EDGE.