# CfnBasePathMappingProps

Properties for defining a `CfnBasePathMapping`.

Extends: CfnBasePathMappingProps
Used as props by: CfnBasePathMapping

- Source: Generated code
- Type last changed: v2.227.0 · 21 Nov 2025

## 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';
const cfnBasePathMappingProps: apigateway.CfnBasePathMappingProps = {
  domainName: 'domainName',

  // the properties below are optional
  basePath: 'basePath',
  id: 'id',
  restApiId: 'restApiId',
  stage: 'stage',
};
```

## Properties

- `basePath`: string — The base path name that callers of the API must provide as part of the URL after the domain name.

- `domainName`: string | [IDomainNameRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_apigateway.IDomainNameRef.html) (required) — The domain name of the BasePathMapping resource to be described.

- `id`: string

- `restApiId`: string | [IRestApiRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_apigateway.IRestApiRef.html) — The string identifier of the associated RestApi.

- `stage`: string | [IStageRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_apigateway.IStageRef.html) — The name of the associated stage.