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

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

AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi

aws-native.apigateway.getBasePathMapping

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi

    Resource Type definition for AWS::ApiGateway::BasePathMapping

    Using getBasePathMapping

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBasePathMapping(args: GetBasePathMappingArgs, opts?: InvokeOptions): Promise<GetBasePathMappingResult>
    function getBasePathMappingOutput(args: GetBasePathMappingOutputArgs, opts?: InvokeOptions): Output<GetBasePathMappingResult>
    def get_base_path_mapping(base_path: Optional[str] = None,
                              domain_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetBasePathMappingResult
    def get_base_path_mapping_output(base_path: Optional[pulumi.Input[str]] = None,
                              domain_name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetBasePathMappingResult]
    func LookupBasePathMapping(ctx *Context, args *LookupBasePathMappingArgs, opts ...InvokeOption) (*LookupBasePathMappingResult, error)
    func LookupBasePathMappingOutput(ctx *Context, args *LookupBasePathMappingOutputArgs, opts ...InvokeOption) LookupBasePathMappingResultOutput

    > Note: This function is named LookupBasePathMapping in the Go SDK.

    public static class GetBasePathMapping 
    {
        public static Task<GetBasePathMappingResult> InvokeAsync(GetBasePathMappingArgs args, InvokeOptions? opts = null)
        public static Output<GetBasePathMappingResult> Invoke(GetBasePathMappingInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBasePathMappingResult> getBasePathMapping(GetBasePathMappingArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:apigateway:getBasePathMapping
      arguments:
        # arguments dictionary

    The following arguments are supported:

    BasePath string

    The base path name that callers of the API must provide in the URL after the domain name.

    DomainName string

    The DomainName of an AWS::ApiGateway::DomainName resource.

    BasePath string

    The base path name that callers of the API must provide in the URL after the domain name.

    DomainName string

    The DomainName of an AWS::ApiGateway::DomainName resource.

    basePath String

    The base path name that callers of the API must provide in the URL after the domain name.

    domainName String

    The DomainName of an AWS::ApiGateway::DomainName resource.

    basePath string

    The base path name that callers of the API must provide in the URL after the domain name.

    domainName string

    The DomainName of an AWS::ApiGateway::DomainName resource.

    base_path str

    The base path name that callers of the API must provide in the URL after the domain name.

    domain_name str

    The DomainName of an AWS::ApiGateway::DomainName resource.

    basePath String

    The base path name that callers of the API must provide in the URL after the domain name.

    domainName String

    The DomainName of an AWS::ApiGateway::DomainName resource.

    getBasePathMapping Result

    The following output properties are available:

    RestApiId string

    The ID of the API.

    Stage string

    The name of the API's stage.

    RestApiId string

    The ID of the API.

    Stage string

    The name of the API's stage.

    restApiId String

    The ID of the API.

    stage String

    The name of the API's stage.

    restApiId string

    The ID of the API.

    stage string

    The name of the API's stage.

    rest_api_id str

    The ID of the API.

    stage str

    The name of the API's stage.

    restApiId String

    The ID of the API.

    stage String

    The name of the API's stage.

    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.77.0 published on Wednesday, Sep 20, 2023 by Pulumi