1. Packages
  2. AWS Native
  3. API Docs
  4. apigatewayv2
  5. ApiMapping

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

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.apigatewayv2.ApiMapping

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

    The AWS::ApiGatewayV2::ApiMapping resource contains an API mapping. An API mapping relates a path of your custom domain name to a stage of your API. A custom domain name can have multiple API mappings, but the paths can’t overlap. A custom domain can map only to APIs of the same protocol type. For more information, see CreateApiMapping in the Amazon API Gateway V2 API Reference.

    Create ApiMapping Resource

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

    Constructor syntax

    new ApiMapping(name: string, args: ApiMappingArgs, opts?: CustomResourceOptions);
    @overload
    def ApiMapping(resource_name: str,
                   args: ApiMappingArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def ApiMapping(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   api_id: Optional[str] = None,
                   domain_name: Optional[str] = None,
                   stage: Optional[str] = None,
                   api_mapping_key: Optional[str] = None)
    func NewApiMapping(ctx *Context, name string, args ApiMappingArgs, opts ...ResourceOption) (*ApiMapping, error)
    public ApiMapping(string name, ApiMappingArgs args, CustomResourceOptions? opts = null)
    public ApiMapping(String name, ApiMappingArgs args)
    public ApiMapping(String name, ApiMappingArgs args, CustomResourceOptions options)
    
    type: aws-native:apigatewayv2:ApiMapping
    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 ApiMappingArgs
    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 ApiMappingArgs
    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 ApiMappingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiMappingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiMappingArgs
    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 apiMappingResource = new aws_native.apigatewayv2.ApiMapping("apiMappingResource", {
        apiId: "string",
        domainName: "string",
        stage: "string",
        apiMappingKey: "string",
    });
    
    Coming soon!
    

    ApiMapping 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 ApiMapping resource accepts the following input properties:

    ApiId string
    The identifier of the API.
    DomainName string
    The domain name.
    Stage string
    The API stage.
    ApiMappingKey string
    The API mapping key.
    ApiId string
    The identifier of the API.
    DomainName string
    The domain name.
    Stage string
    The API stage.
    ApiMappingKey string
    The API mapping key.
    apiId String
    The identifier of the API.
    domainName String
    The domain name.
    stage String
    The API stage.
    apiMappingKey String
    The API mapping key.
    apiId string
    The identifier of the API.
    domainName string
    The domain name.
    stage string
    The API stage.
    apiMappingKey string
    The API mapping key.
    api_id str
    The identifier of the API.
    domain_name str
    The domain name.
    stage str
    The API stage.
    api_mapping_key str
    The API mapping key.
    apiId String
    The identifier of the API.
    domainName String
    The domain name.
    stage String
    The API stage.
    apiMappingKey String
    The API mapping key.

    Outputs

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

    ApiMappingId string
    The API mapping resource ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    ApiMappingId string
    The API mapping resource ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    apiMappingId String
    The API mapping resource ID.
    id String
    The provider-assigned unique ID for this managed resource.
    apiMappingId string
    The API mapping resource ID.
    id string
    The provider-assigned unique ID for this managed resource.
    api_mapping_id str
    The API mapping resource ID.
    id str
    The provider-assigned unique ID for this managed resource.
    apiMappingId String
    The API mapping resource ID.
    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.108.3 published on Wednesday, Jun 12, 2024 by Pulumi