Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigateway
  5. BasePathMappingV2

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.15.0 published on Wednesday, Dec 11, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigateway.BasePathMappingV2

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.15.0 published on Wednesday, Dec 11, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::ApiGateway::BasePathMappingV2

    Create BasePathMappingV2 Resource

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

    Constructor syntax

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

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

    type: aws-native:apigateway:BasePathMappingV2
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 BasePathMappingV2Args
    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 BasePathMappingV2Args
    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 BasePathMappingV2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BasePathMappingV2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BasePathMappingV2Args
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    BasePathMappingV2 Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The BasePathMappingV2 resource accepts the following input properties:

    DomainNameArn string
    The Arn of an AWS::ApiGateway::DomainNameV2 resource.
    RestApiId string
    The ID of the API.
    BasePath string
    The base path name that callers of the API must provide in the URL after the domain name.
    Stage string
    The name of the API's stage.
    DomainNameArn string
    The Arn of an AWS::ApiGateway::DomainNameV2 resource.
    RestApiId string
    The ID of the API.
    BasePath string
    The base path name that callers of the API must provide in the URL after the domain name.
    Stage string
    The name of the API's stage.
    domainNameArn String
    The Arn of an AWS::ApiGateway::DomainNameV2 resource.
    restApiId String
    The ID of the API.
    basePath String
    The base path name that callers of the API must provide in the URL after the domain name.
    stage String
    The name of the API's stage.
    domainNameArn string
    The Arn of an AWS::ApiGateway::DomainNameV2 resource.
    restApiId string
    The ID of the API.
    basePath string
    The base path name that callers of the API must provide in the URL after the domain name.
    stage string
    The name of the API's stage.
    domain_name_arn str
    The Arn of an AWS::ApiGateway::DomainNameV2 resource.
    rest_api_id str
    The ID of the API.
    base_path str
    The base path name that callers of the API must provide in the URL after the domain name.
    stage str
    The name of the API's stage.
    domainNameArn String
    The Arn of an AWS::ApiGateway::DomainNameV2 resource.
    restApiId String
    The ID of the API.
    basePath String
    The base path name that callers of the API must provide in the URL after the domain name.
    stage String
    The name of the API's stage.

    Outputs

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

    BasePathMappingArn string
    Amazon Resource Name (ARN) of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    BasePathMappingArn string
    Amazon Resource Name (ARN) of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    basePathMappingArn String
    Amazon Resource Name (ARN) of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    basePathMappingArn string
    Amazon Resource Name (ARN) of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    base_path_mapping_arn str
    Amazon Resource Name (ARN) of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    basePathMappingArn String
    Amazon Resource Name (ARN) of the 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

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.15.0 published on Wednesday, Dec 11, 2024 by Pulumi
    pulumi/pulumi-aws-native