AwsApiGatewayRestCustomDomainArgs

interface AwsApiGatewayRestCustomDomainArgs {
basePath?: Input<string>;
certificate: AwsApiGatewayRestCustomDomainCertificateArgs;
domainName: Input<string>;
endpointAccessMode?: Input<AwsApiGatewayRestCustomDomainEndpointAccessMode>;
endpointType?: AwsApiGatewayRestCustomDomainEndpointType;
mappingTarget?: AwsApiGatewayRestCustomDomainMappingTargetArgs;
securityPolicy?: Input<string>;
}

REST custom-domain settings for AwsApiGatewayRestArgs.

Example

CODE

const customDomain: AwsApiGatewayRestCustomDomainArgs = {
  domainName: 'api.example.com',
  endpointType: 'REGIONAL',
  securityPolicy: 'SecurityPolicy_TLS13_1_3_2025_09',
  endpointAccessMode: 'BASIC',
  certificate: {
    regionalCertificateArn: regionalCertificate.arn,
  },
};

Properties

`basePath: Input<string>`

Optional base path mapping value.

`certificate: AwsApiGatewayRestCustomDomainCertificateArgs`

Certificate settings selected by endpoint type.

`domainName: Input<string>`

Fully qualified domain name for API Gateway custom domain.

`endpointAccessMode: Input<AwsApiGatewayRestCustomDomainEndpointAccessMode>`

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

`endpointType: AwsApiGatewayRestCustomDomainEndpointType`

Endpoint type. Defaults to REGIONAL.

`mappingTarget: AwsApiGatewayRestCustomDomainMappingTargetArgs`

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

`securityPolicy: Input<string>`

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.