Class ApiMapping

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

Example Usage

Basic

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.ApiGatewayV2.ApiMapping("example", new Aws.ApiGatewayV2.ApiMappingArgs
    {
        ApiId = aws_apigatewayv2_api.Example.Id,
        DomainName = aws_apigatewayv2_domain_name.Example.Id,
        Stage = aws_apigatewayv2_stage.Example.Id,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

ApiMapping

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.ApiGatewayV2

Assembly: Pulumi.Aws.dll

Syntax

public class ApiMapping : CustomResource

Constructors

ApiMapping(String, ApiMappingArgs, CustomResourceOptions)

Create a ApiMapping resource with the given unique name, arguments, and options.

Declaration

public ApiMapping(string name, ApiMappingArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ApiMappingArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ApiId

The API identifier.

Declaration

public Output<string> ApiId { get; }

Property Value

Type	Description
Output<System.String>

ApiMappingKey

The API mapping key.

Declaration

public Output<string> ApiMappingKey { get; }

Property Value

Type	Description
Output<System.String>

DomainName

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

Declaration

public Output<string> DomainName { get; }

Property Value

Type	Description
Output<System.String>

Stage

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

Declaration

public Output<string> Stage { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, ApiMappingState, CustomResourceOptions)

Get an existing ApiMapping resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static ApiMapping Get(string name, Input<string> id, ApiMappingState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ApiMappingState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
ApiMapping