Class CfnApiMapping

The AWS::ApiGatewayV2::ApiMapping resource contains an API mapping.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnApiMapping

Implements

IInspectable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Apigatewayv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnApiMapping : CfnResource, IInspectable

Syntax (vb)

Public Class CfnApiMapping Inherits CfnResource Implements IInspectable

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html

CloudformationResource: AWS::ApiGatewayV2::ApiMapping

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Apigatewayv2;

             var cfnApiMapping = new CfnApiMapping(this, "MyCfnApiMapping", new CfnApiMappingProps {
                 ApiId = "apiId",
                 DomainName = "domainName",
                 Stage = "stage",

                 // the properties below are optional
                 ApiMappingKey = "apiMappingKey"
             });

Synopsis

Constructors

CfnApiMapping(Construct, string, ICfnApiMappingProps)

The AWS::ApiGatewayV2::ApiMapping resource contains an API mapping.

Properties

ApiId	The API identifier.
ApiMappingKey	The API mapping key.
AttrApiMappingId	The API mapping resource ID.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::ApiGatewayV2::ApiMapping resource contains an API mapping.
DomainName	The domain name.
Stage	The API stage.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	The AWS::ApiGatewayV2::ApiMapping resource contains an API mapping.

Constructors

CfnApiMapping(Construct, string, ICfnApiMappingProps)

The AWS::ApiGatewayV2::ApiMapping resource contains an API mapping.

public CfnApiMapping(Construct scope, string id, ICfnApiMappingProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnApiMappingProps

Resource properties.

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html

CloudformationResource: AWS::ApiGatewayV2::ApiMapping

ExampleMetadata: fixture=_generated

Properties

ApiId

The API identifier.

public virtual string ApiId { get; set; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html

CloudformationResource: AWS::ApiGatewayV2::ApiMapping

ExampleMetadata: fixture=_generated

ApiMappingKey

The API mapping key.

public virtual string? ApiMappingKey { get; set; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html

CloudformationResource: AWS::ApiGatewayV2::ApiMapping

ExampleMetadata: fixture=_generated

AttrApiMappingId

The API mapping resource ID.

public virtual string AttrApiMappingId { get; }

Property Value

string

Remarks

CloudformationAttribute: ApiMappingId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html

CloudformationResource: AWS::ApiGatewayV2::ApiMapping

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::ApiGatewayV2::ApiMapping resource contains an API mapping.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html

CloudformationResource: AWS::ApiGatewayV2::ApiMapping

ExampleMetadata: fixture=_generated

DomainName

The domain name.

public virtual string DomainName { get; set; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html

CloudformationResource: AWS::ApiGatewayV2::ApiMapping

ExampleMetadata: fixture=_generated

Stage

The API stage.

public virtual string Stage { get; set; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html

CloudformationResource: AWS::ApiGatewayV2::ApiMapping

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html

CloudformationResource: AWS::ApiGatewayV2::ApiMapping

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::ApiGatewayV2::ApiMapping resource contains an API mapping.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html

CloudformationResource: AWS::ApiGatewayV2::ApiMapping

ExampleMetadata: fixture=_generated

Implements

IInspectable