Paws::ApiGateway::CreateBasePathMapping - Arguments for method CreateBasePathMapping on Paws::ApiGateway


This class represents the parameters used for calling the method CreateBasePathMapping on the Amazon API Gateway service. Use the attributes of this class as arguments to method CreateBasePathMapping.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateBasePathMapping.


    my $apigateway = Paws->service('ApiGateway');
    my $BasePathMapping = $apigateway->CreateBasePathMapping(
      DomainName => 'MyString',
      RestApiId  => 'MyString',
      BasePath   => 'MyString',    # OPTIONAL
      Stage      => 'MyString',    # OPTIONAL

    # Results:
    my $BasePath  = $BasePathMapping->BasePath;
    my $RestApiId = $BasePathMapping->RestApiId;
    my $Stage     = $BasePathMapping->Stage;

    # Returns a L<Paws::ApiGateway::BasePathMapping> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see


BasePath => Str

The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify a base path name after the domain name.

REQUIRED DomainName => Str

[Required] The domain name of the BasePathMapping resource to create.

REQUIRED RestApiId => Str

[Required] The string identifier of the associated RestApi.

Stage => Str

The name of the API's stage that you want to use for this mapping. Leave this blank if you do not want callers to explicitly specify the stage name after any base path name.


This class forms part of Paws, documenting arguments for method CreateBasePathMapping in Paws::ApiGateway


The source code is located here:

Please report bugs to: