Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. apigateway
  5. BasePathMapping

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigateway.BasePathMapping

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

    The AWS::ApiGateway::BasePathMapping resource creates a base path that clients who call your API must use in the invocation URL.

    Create BasePathMapping Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new BasePathMapping(name: string, args: BasePathMappingArgs, opts?: CustomResourceOptions);
    @overload
def BasePathMapping(resource_name: str,
                    args: BasePathMappingArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def BasePathMapping(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    domain_name: Optional[str] = None,
                    base_path: Optional[str] = None,
                    rest_api_id: Optional[str] = None,
                    stage: Optional[str] = None)
    func NewBasePathMapping(ctx *Context, name string, args BasePathMappingArgs, opts ...ResourceOption) (*BasePathMapping, error)
    public BasePathMapping(string name, BasePathMappingArgs args, CustomResourceOptions? opts = null)
    public BasePathMapping(String name, BasePathMappingArgs args)
public BasePathMapping(String name, BasePathMappingArgs args, CustomResourceOptions options)

    type: aws-native:apigateway:BasePathMapping
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args BasePathMappingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BasePathMappingArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BasePathMappingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BasePathMappingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BasePathMappingArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const basePathMappingResource = new aws_native.apigateway.BasePathMapping("basePathMappingResource", {
    domainName: "string",
    basePath: "string",
    restApiId: "string",
    stage: "string",
});

    Coming soon!

    BasePathMapping Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The BasePathMapping resource accepts the following input properties:

    DomainName string
    The domain name of the BasePathMapping resource to be described.
    BasePath string
    The base path name that callers of the API must provide as part of the URL after the domain name.
    RestApiId string
    The string identifier of the associated RestApi.
    Stage string
    The name of the associated stage.
    DomainName string
    The domain name of the BasePathMapping resource to be described.
    BasePath string
    The base path name that callers of the API must provide as part of the URL after the domain name.
    RestApiId string
    The string identifier of the associated RestApi.
    Stage string
    The name of the associated stage.
    domainName String
    The domain name of the BasePathMapping resource to be described.
    basePath String
    The base path name that callers of the API must provide as part of the URL after the domain name.
    restApiId String
    The string identifier of the associated RestApi.
    stage String
    The name of the associated stage.
    domainName string
    The domain name of the BasePathMapping resource to be described.
    basePath string
    The base path name that callers of the API must provide as part of the URL after the domain name.
    restApiId string
    The string identifier of the associated RestApi.
    stage string
    The name of the associated stage.
    domain_name str
    The domain name of the BasePathMapping resource to be described.
    base_path str
    The base path name that callers of the API must provide as part of the URL after the domain name.
    rest_api_id str
    The string identifier of the associated RestApi.
    stage str
    The name of the associated stage.
    domainName String
    The domain name of the BasePathMapping resource to be described.
    basePath String
    The base path name that callers of the API must provide as part of the URL after the domain name.
    restApiId String
    The string identifier of the associated RestApi.
    stage String
    The name of the associated stage.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BasePathMapping resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-aws-native