ApiMapping class
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/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_apigatewayv2_apimapping" "example" {
api_id = exampleAwsApigatewayv2Api.id
domain_name = exampleAwsApigatewayv2DomainName.id
stage = exampleAwsApigatewayv2Stage.id
}
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.ArrayList;
import java.util.Arrays;
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.ApiMapping using the API mapping identifier and domain name. For example:
$ pulumi import aws:apigatewayv2/apiMapping:ApiMapping example 1122334/ws-api.example.com
Constructors
- ApiMapping(String name, {ApiMappingArgs? args, CustomResourceOptions? options})
-
Creates a new ApiMapping.
nameThe Pulumi resource name.argsArguments used to configure this ApiMapping. The set of arguments for ApiMapping.optionsResource options controlling this resource's behavior. - ApiMapping.reference(String urn)
- Creates a typed reference to an existing ApiMapping resource.
Properties
-
apiId
↔ Output<
String> -
API identifier.
latefinal
-
apiMappingKey
↔ Output<
String?> -
API mapping key. Refer to REST API, HTTP API or WebSocket API.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
domainName
↔ Output<
String> -
Domain name. Use the
aws.apigatewayv2.DomainNameresource to configure a domain name.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
stage
↔ Output<
String> -
API stage. Use the
aws.apigatewayv2.Stageresource to configure an API stage.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {ApiMappingState? state, CustomResourceOptions? options}) → ApiMapping -
Gets an existing ApiMapping resource's state with the given
nameandid.