BasePathMapping

class aws_cdk.aws_apigateway.BasePathMapping(scope, id, *, domain_name, rest_api, base_path=None)

Bases: aws_cdk.core.Resource

This resource creates a base path that clients who call your API must use in the invocation URL.

In most cases, you will probably want to use DomainName.addBasePathMapping() to define mappings.

__init__(scope, id, *, domain_name, rest_api, base_path=None)
Parameters
  • scope (Construct) –

  • id (str) –

  • props

  • domain_name (IDomainName) – The DomainName to associate with this base path mapping.

  • rest_api (IRestApi) – The RestApi resource to target.

  • base_path (Optional[str]) – The base path name that callers of the API must provide in the URL after the domain name (e.g. example.com/base-path). If you specify this property, it can’t be an empty string. Default: - map requests from the domain root (e.g. example.com). If this is undefined, no additional mappings will be allowed on this domain name.

Return type

None

Methods

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

node

Construct tree node which offers APIs for interacting with the construct tree.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool