ApiMappingArgs

data class ApiMappingArgs(val apiId: Output<String>? = null, val apiMappingKey: Output<String>? = null, val domainName: Output<String>? = null, val stage: Output<String>? = null) : ConvertibleToJava<ApiMappingArgs>

Manages an Amazon API Gateway Version 2 API mapping. More information can be found in the Amazon API Gateway Developer Guide.

Example Usage

Basic

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.apigatewayv2.ApiMapping("example", {
apiId: exampleAwsApigatewayv2Api.id,
domainName: exampleAwsApigatewayv2DomainName.id,
stage: exampleAwsApigatewayv2Stage.id,
});
import pulumi
import pulumi_aws as aws
example = aws.apigatewayv2.ApiMapping("example",
api_id=example_aws_apigatewayv2_api["id"],
domain_name=example_aws_apigatewayv2_domain_name["id"],
stage=example_aws_apigatewayv2_stage["id"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.ApiGatewayV2.ApiMapping("example", new()
{
ApiId = exampleAwsApigatewayv2Api.Id,
DomainName = exampleAwsApigatewayv2DomainName.Id,
Stage = exampleAwsApigatewayv2Stage.Id,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/apigatewayv2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apigatewayv2.NewApiMapping(ctx, "example", &apigatewayv2.ApiMappingArgs{
ApiId: pulumi.Any(exampleAwsApigatewayv2Api.Id),
DomainName: pulumi.Any(exampleAwsApigatewayv2DomainName.Id),
Stage: pulumi.Any(exampleAwsApigatewayv2Stage.Id),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigatewayv2.ApiMapping;
import com.pulumi.aws.apigatewayv2.ApiMappingArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new ApiMapping("example", ApiMappingArgs.builder()
.apiId(exampleAwsApigatewayv2Api.id())
.domainName(exampleAwsApigatewayv2DomainName.id())
.stage(exampleAwsApigatewayv2Stage.id())
.build());
}
}
resources:
example:
type: aws:apigatewayv2:ApiMapping
properties:
apiId: ${exampleAwsApigatewayv2Api.id}
domainName: ${exampleAwsApigatewayv2DomainName.id}
stage: ${exampleAwsApigatewayv2Stage.id}

Import

Using pulumi import, import aws_apigatewayv2_api_mapping using the API mapping identifier and domain name. For example:

$ pulumi import aws:apigatewayv2/apiMapping:ApiMapping example 1122334/ws-api.example.com

Constructors

Link copied to clipboard
constructor(apiId: Output<String>? = null, apiMappingKey: Output<String>? = null, domainName: Output<String>? = null, stage: Output<String>? = null)

Properties

Link copied to clipboard
val apiId: Output<String>? = null

API identifier.

Link copied to clipboard
val apiMappingKey: Output<String>? = null

The API mapping key. Refer to REST API, HTTP API or WebSocket API.

Link copied to clipboard
val domainName: Output<String>? = null

Domain name. Use the aws.apigatewayv2.DomainName resource to configure a domain name.

Link copied to clipboard
val stage: Output<String>? = null

API stage. Use the aws.apigatewayv2.Stage resource to configure an API stage.

Functions

Link copied to clipboard
open override fun toJava(): ApiMappingArgs