pulumi-aws-kotlin/com.pulumi.aws.apigatewayv2.kotlin/ApiMapping

ApiMapping

class ApiMapping : KotlinCustomResource

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

Example Usage

Basic

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(aws_apigatewayv2_api.example().id())
            .domainName(aws_apigatewayv2_domain_name.example().id())
            .stage(aws_apigatewayv2_stage.example().id())
            .build());
    }
}

Import

aws_apigatewayv2_api_mapping can be imported by using the API mapping identifier and domain name, e.g.,

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

Properties

apiId

val apiId: Output<String>

API identifier.

apiMappingKey

val apiMappingKey: Output<String>?

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

domainName

val domainName: Output<String>

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

val id: Output<String>

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

stage

val stage: Output<String>

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

urn

val urn: Output<String>